An open API service indexing awesome lists of open source software.

https://github.com/annakrystalli/rrcompendiumdtb

Full Reproducible Research Compendium produced with rrtools including travis, dockerfile & binder setup
https://github.com/annakrystalli/rrcompendiumdtb

binder-ready dockerized research-compendium rrtools rstats travis-ci

Last synced: 3 months ago
JSON representation

Full Reproducible Research Compendium produced with rrtools including travis, dockerfile & binder setup

Awesome Lists containing this project

README

        

---
output: github_document
---

```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```

# rrcompendiumDTB

[![Travis-CI Build Status](https://travis-ci.com/annakrystalli/rrcompendiumDTB.svg?branch=master)](https://travis-ci.com/annakrystalli/rrcompendiumDTB)
[![Launch Rstudio Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/annakrystalli/rrcompendiumDTB/master?urlpath=rstudio)

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_.

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

### 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

### How to download or install

You can download the compendium as a zip from from this URL:

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: [![Launch Rstudio Binder](http://mybinder.org/badge_logo.svg)](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.