TODO: add a description of the repo and links to further documentation if needed (eg., a github page)
TODO: add software requirements, for example:
- R version 4.0.0 or higher
- Windows, macOS, or Linux operating system
TODO: review the local installation links and documentation
This repo can be installed to your local machine or you can run code using a Github Codespace. If you want to run the code but don't want to install anything on your local machine, use a Github Codespace
If you want to run the code but don't want to install anything on your local machine, use a Github Codespace.
-
At the root of the repo, click on the Code drop down button
-
On the right there is a tab called Codespaces.
-
Click the + sign and a Codespace will launch
-
The default codespace configuration has R and Rstudio set up for it (so probably use that one)
-
If there are multiple configurations (maybe an R and a Python container) you can select which configuration to use by clicking the 3 dots ... like below and selecting New with options...
-
-
You can run Rstudio within a Codespace by:
- Go into the VS Code section called "Ports" in the Codespace (in the terminal window in the bottom panel)
- Find the port labeled "Rstudio"
- Click the Open in Browser button
Now you can run the repo code in a browser window without needing to install any software on your computer 😎
- Clone the repository:
git clone <link to github repo>- Navigate to the repo folder
cd folder- Open up the
folder.RprojR project:
Can double click on the file or open in a terminal window by typing folder.Rproj
- Install
renv
In the Rstudio window's console, execute
install.packages('renv')- Install all the packages in the root directory:
renv::restore()TODO: describe how the repo can or should be used and maybe what variables or outputs are produced. A table of variables could be useful here
TODO: add how someone can contribute