Readme file for Dissertation project R code.
Bold remotes R chunk:
install.packages("remotes") # If you do not already have the remotes package
remotes::install_github("ITSleeds/RpackageTemplate")
- Create a new repo on GitHub in an appropriate organisation. You can use this template by clicking the “Use this template” button in the top right hand corner of this page.
- Clone the package onto your computer, e.g. by typing
git clone git@github.com:itsleeds/youPackageName
in a Linux terminal (try pressingCtl+Shift+T
in RStudio to get to the terminal or open Windows Powershell) - Change the name of the .Rproj file, e.g. with the following commands in terminal
cd testPackage
mv RpackageTemplate.Rproj yourPackageName.Rproj
- Open the project in RStudio as follows:
rstudioapi::openProject("/path/to/yourPackageName")
To add continuous integration, use the following commands:
# usethis::use_pkgdown()
usethis::use_pkgdown_travis()
travis::use_travis_deploy()
See these resources for further information:
- https://pkgdown.r-lib.org/articles/pkgdown.html
- https://pkgdown.r-lib.org/reference/deploy_site_github.html
Acknowledge all the fine people who helped build this package.
Please note that the RpackageTemplate
project is released with a
Contributor Code of Conduct. By contributing to
this project, you agree to abide by its terms.
This package is part of ongoing research at the University of Leeds, it is provided “as is” and is likely to be updated and changed without warning to meet the research needs of the University.