Skip to content

Commit 8d41594

Browse files
authored
Update README.md
close #161
1 parent 0b4f177 commit 8d41594

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Motivation
99

10-
The goal of **rrtools** is to provide instructions, templates, and functions for making a basic compendium suitable for writing a reproducible journal article or report with [R](https://www.r-project.org). This package documents the key steps and provides convenient functions for quickly creating a new research compendium. The approach is based on [Marwick (2017)](https://doi.org/10.1007/s10816-015-9272-9), [Marwick et al. (2018)](https://doi.org/10.7287/peerj.preprints.3192v1), and [Wickham’s (2017)](https://docs.google.com/document/d/1LzZKS44y4OEJa4Azg5reGToNAZL0e0HSUwxamNY7E-Y/edit#) work using the R package structure as the basis for a research compendium.
10+
The goal of **rrtools** is to provide instructions, templates, and functions for making a basic compendium suitable for writing a reproducible journal article or report with [R](https://www.r-project.org). This package documents the key steps and provides convenient functions for quickly creating a new research compendium. The approach is based on Marwick et al.'s [(2017](https://doi.org/10.1007/s10816-015-9272-9), [Marwick et al. 2018](https://doi.org/10.7287/peerj.preprints.3192v1)) work using the R package structure as the basis for a research compendium.
1111

1212
rrtools provides a template for doing scholarly writing in a literate programming environment using [Quarto](https://quarto.org/), an open-source scientific and technical publishing system. It also allows for isolation of your computational environment using [Docker](https://www.docker.com/what-docker), package versioning using [renv](https://rstudio.github.io/renv/index.html), and continuous integration using [GitHub Actions](https://github.com/features/actions). It makes a convenient starting point for writing a journal article or report.
1313

@@ -121,10 +121,9 @@ You should be able to follow these steps to get a new research compendium reposi
121121

122122
## References and related reading
123123

124-
Kitzes, J., Turek, D., & Deniz, F. (Eds.). (2017). *The Practice of
124+
Kitzes, J., Turek, D., & Deniz, F. (Eds.). (2017). [*The Practice of
125125
Reproducible Research: Case Studies and Lessons from the Data-Intensive
126-
Sciences*. Oakland, CA: University of California Press.
127-
<https://www.practicereproducibleresearch.org>
126+
Sciences*](https://www.ucpress.edu/books/the-practice-of-reproducible-research/paper). Oakland, CA: University of California Press.
128127

129128
Marwick, B. (2017). Computational reproducibility in archaeological
130129
research: Basic principles and a case study of their implementation.
@@ -149,10 +148,6 @@ Science: Software Infrastructure and Environments for Reproducible and
149148
Extensible Research. Journal of Open Research Software. 2(1), p.e21.
150149
DOI: <http://doi.org/10.5334/jors.ay>
151150

152-
Wickham, H. (2017) *Research compendia*. Note prepared for the 2017
153-
rOpenSci Unconf.
154-
<https://docs.google.com/document/d/1LzZKS44y4OEJa4Azg5reGToNAZL0e0HSUwxamNY7E-Y/edit#>
155-
156151
Wilson G, Bryan J, Cranston K, Kitzes J, Nederbragt L, et al. (2017).
157152
Good enough practices in scientific computing. *PLOS Computational
158153
Biology* 13(6): e1005510. <https://doi.org/10.1371/journal.pcbi.1005510>

0 commit comments

Comments
 (0)