https://github.com/GregoryIreland/R_template_test
https://github.com/GregoryIreland/R_template_test
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/GregoryIreland/R_template_test
- Owner: GregoryIreland
- License: agpl-3.0
- Created: 2020-11-26T12:31:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-26T12:31:34.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:14:07.954Z (8 months ago)
- Language: R
- Size: 13.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - GregoryIreland/R_template_test - (R)
README
# rli\_template\_r
A template for new data analysis projects written in R at the RLI.
You can use this template to prepare a new Github repository for collaborative data analysis projects using the R statistical programming language. This is an opinionated template and suggests a folder structure as well as data management processes to make collaboration smoother within and outside the RLI.
Simply click on the green `Use this template` button on the left of the `Clone or download` button.
The detailed instructions to create a new repository from this template can be found [here](https://help.github.com/en/articles/creating-a-repository-from-a-template).
## renv
You must run `renv::init()` and select the option that activates the current renv with your project. This must only be run once. You can then install the packages you want to work with in this project as you normally do, and then you can save a snapshot of these using `renv::snapshot()`. Every other user now just runs `renv::restore()` on their local machine to get the exact same packages versions that you have used. More information can be found here: `https://rstudio.github.io/renv/articles/collaborating.html`
Once you have created the new repository, you can remove everything before and including this line.
# Project Name
Briefly describe the project aims and project partners, as well as the funding agenc(y)ies.
## Get started
Please review the CONTRIBUTING.md file describing how to engage with this project.
## Basic folder structure
- **R** contains all .R and .Rmd scripts.
- **Data** is and remains *empty* in the repository. This is populated with a separate data download process on your local machine. Please review datadown.R in the R folder for further information.
- **Output** is where the final .Rmd, .pdf, .docx, .tex, .png, or similar result presentation scripts or files of the project are stored.
- **renv** contains a project-local library of packages.