generated from itsleeds/RpackageTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a6624d8
commit 07a5f9e
Showing
1 changed file
with
12 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,110 +1,15 @@ | ||
|
||
<!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
||
<!-- [![Travis build status](https://travis-ci.org/ITSLeeds/RpackageTemplate.svg?branch=master)](https://travis-ci.org/ITSLeeds/RpackageTemplate) --> | ||
|
||
<!-- [![Coverage status](https://codecov.io/gh/ITSLeeds/RpackageTemplate/branch/master/graph/badge.svg)](https://codecov.io/github/ITSLeeds/RpackageTemplate?branch=master) --> | ||
|
||
<!-- [![Build status](https://ci.appveyor.com/api/projects/status/gqp3smc04as3qg85?svg=true)](https://ci.appveyor.com/project/layik/RpackageTemplate-05ana) --> | ||
|
||
![tic](https://github.com/ITSLeeds/RpackageTemplate/workflows/tic/badge.svg) | ||
[![Project Status: Active – The project has reached a stable, usable | ||
state and is being actively | ||
developed.](https://www.repostatus.org/badges/latest/active.svg)](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.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 | ||
|
||
<!-- end list --> | ||
|
||
``` bash | ||
cd testPackage | ||
mv RpackageTemplate.Rproj yourPackageName.Rproj | ||
``` | ||
|
||
- Open the project in RStudio as follows: | ||
|
||
<!-- end list --> | ||
|
||
``` r | ||
rstudioapi::openProject("/path/to/yourPackageName") | ||
``` | ||
|
||
## Continuous integration | ||
|
||
To add continuous integration, use the following commands: | ||
|
||
``` r | ||
remotes::install_github("ropensci/tic") | ||
tic::use_tic() | ||
``` | ||
|
||
You can use defaults, such as: | ||
|
||
``` r | ||
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 | ||
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. | ||
# Prioritise links | ||
|
||
The purpose of this repository is to create a standardised method that | ||
can be used to prioritise the links within a cycle route network that | ||
have the greatest need for new cycle infrastructure. This prioritisation | ||
is based on two segment-level attributes - cycling potential and the | ||
existing quality of cycle provision. | ||
|
||
Cycling potential could relate to current or future modelled cycling | ||
levels. Existing quality of cycle provision is assessed using the | ||
CycleStreets quietness metric, which is a measurement of ‘cycle | ||
friendliness.’ |