Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ITSLeeds/RpackageTemplate
Template to form the basis of ITSLeeds R packages
https://github.com/ITSLeeds/RpackageTemplate
Last synced: 3 months ago
JSON representation
Template to form the basis of ITSLeeds R packages
- Host: GitHub
- URL: https://github.com/ITSLeeds/RpackageTemplate
- Owner: ITSLeeds
- License: gpl-3.0
- Created: 2019-05-30T13:17:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-30T04:05:01.000Z (about 4 years ago)
- Last Synced: 2024-05-21T02:11:55.684Z (6 months ago)
- Language: R
- Size: 121 KB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
[](https://www.repostatus.org/#active)
# RpackageTemplate
Template to form the basis of ITSLeeds R packages
## Installation
Install the package with **remotes** as follows:
```{r install, eval=FALSE}
install.packages("remotes") # If you do not already have the remotes package
Change the contents to "user/repo", e.g:
# remotes::install_github("ropensci/stplanr") # for the stplanr package
remotes::install_github("ITSleeds/RpackageTemplate")
```
## Usage
To create a new package and get it on your computer:
- Create a new repo on GitHub in an appropriate organisation. You can use this template by clicking the "[Use this template](https://github.com/ITSLeeds/RpackageTemplate/generate)" button in the top right hand corner of this page.
- Clone the package onto your computer, e.g. by typing `git clone [email protected]:itsleeds/youPackageName` in a Linux terminal (try pressing `Ctl+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
```bash
cd testPackage
mv RpackageTemplate.Rproj yourPackageName.Rproj
```
- Open the project in RStudio as follows:
```{r, eval=FALSE}
rstudioapi::openProject("/path/to/yourPackageName")
```
## Continuous integration
To add continuous integration, use the following commands:
```{r, eval=FALSE}
remotes::install_github("ropensci/tic")
tic::use_tic()
```
You can use defaults, such as:
```{r, eval=FALSE}
tic::use_tic(wizard = FALSE, linux = "ghactions", mac = "ghactions", windows = "ghactions",
deploy = "ghactions", matrix = "none")
```
Which will use GitHub Actions.
If you want to create a package website, you can use the following command:
```{r, eval=FALSE}
usethis::use_pkgdown()
```
## Resources
See these resources for further information:
- Free and open source book on creating R packages: https://r-pkgs.org/
- Excellent documentation on continuous integration: https://docs.ropensci.org/tic/
- https://pkgdown.r-lib.org/articles/pkgdown.html
- https://pkgdown.r-lib.org/reference/deploy_site_github.html
## Acknowledgement
Acknowledge all the fine people who helped build this package.
## Contribution
Please note that the `RpackageTemplate` project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
## Package Status
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.