-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
56 lines (38 loc) · 1.44 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
# r-template
Templated R Project skeleton with useful structure and packages
## Initial Installation
1. Install `R` via homebrew or [CRAN](https://cran.r-project.org/bin/).
2. Just start `R` in the project directory and `renv` will begin setup! (Go grab a :coffee: as this will take a while...)
3. Install `tidyverse` and other dev dependencies with `renv::install()`.
### Dependency Conflicts
Package dependencies can sometimes conflict with local r caches. Typically following the suggested fixes via `renv` or
homebrew will resolve the conflicts.
#### Updating the Documentation and Using .Rmd
Pandoc _may_ be required to generate the README as well as use .Rmd files. If
you are using RStudio you can ‘Knit’ or run the following via the cmdline. If you are
not using RStudio you may have to install pandoc
[globally](https://pandoc.org/installing.html).
To update this file run:
``` r
rmarkdown::render('README.Rmd', 'md_document')
```
### _OPTIONAL_ - Install the latest version of renv globally from CRAN with:
``` shell
cd ~/
R
```
then
``` r
install.packages("renv")
```
## Components
This template is mainly comprised with the following tools and aggregate packages.
[renv](https://rstudio.github.io/renv/articles/renv.html)
[Tidyverse](https://www.tidyverse.org/)