-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
73 lines (43 loc) · 2.8 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# rrcompendiumDTB
<!-- badges: start -->
[](https://travis-ci.com/annakrystalli/rrcompendiumDTB)
[](https://mybinder.org/v2/gh/annakrystalli/rrcompendiumDTB/master?urlpath=rstudio)
<!-- badges: end -->
This repository contains the data and code for our reproduction paper:
> Krystalli, A, (2018). _Partial Reproduction of Boettiger Ecology Letters 2018;21:1255–1267 with rrtools_. <https://doi.org/{DOI-to-paper}>
Our reproduction pre-print is online here:
> Krystalli, A, (2018). _Partial Reproduction of Boettiger Ecology Letters 2018;21:1255–1267 with rrtools_, Accessed `r format(Sys.Date(), "%d %b %Y")`. Online at <https://doi.org/{DOI-to-compendium}>
### How to cite
Please cite this compendium as:
> Krystalli, A, (`r format(Sys.Date(), "%Y")`). _Compendium of R code and data for 'Partial Reproduction of Boettiger Ecology Letters 2018;21:1255–1267 with rrtools'_. Accessed `r format(Sys.Date(), "%d %b %Y")`. Online at <https://doi.org/{DOI-to-compendium}>
### How to download or install
You can download the compendium as a zip from from this URL: <https://github.com/annakrystalli/rrcompendiumDTB/archive/master.zip>
You can install compendium functionality as an R package, `rrcompendiumDTB` by running `devtools::install()` in the root directory of the compendium.
Or from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
remotes::install_github("annakrystalli/rrcompendiumDTB")
```
### Reproducing the paper
The paper can be found at `analysis/paper/paper.Rmd`. Open the file and click on **knit** to reproduce the paper. Or run:
```{r cmp-knit, eval = FALSE}
rmarkdown::render(file.path("analysis", "paper", "paper.Rmd"))
```
You can perform this on your local machine or in the cloud: [](https://mybinder.org/v2/gh/annakrystalli/rrcompendiumDTB/master?urlpath=rstudio)
### Licenses
**Text and figures :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/) Copyright (c) 2018 Carl Boettiger.
**Code :** See the [DESCRIPTION](DESCRIPTION) file
**Data :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/), Copyright (c) 2018 Carl Boettiger.
### Contributions
We welcome contributions from everyone. Before you get started, please see our [contributor guidelines](CONTRIBUTING.md). Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.