-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
106 lines (68 loc) · 3.49 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- [](https://travis-ci.org/ITSLeeds/RpackageTemplate) -->
<!-- [](https://codecov.io/github/ITSLeeds/RpackageTemplate?branch=master) -->
<!-- [](https://ci.appveyor.com/project/layik/RpackageTemplate-05ana) -->
[](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.