Last updated: 2018-10-30

workflowr checks: (Click a bullet for more information)

  • ✔ R Markdown file: up-to-date

    Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

  • ✔ Repository version: f7c3c51

    Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility. The version displayed above was the version of the Git repository at the time these results were generated.

    Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated: 
    
Ignored files:
    Ignored:    .DS_Store
    Ignored:    .Rhistory
    Ignored:    .Rproj.user/
    Ignored:    analysis/.DS_Store
    Ignored:    analysis/data/
    Ignored:    analysis/package.Rmd
    Ignored:    assets/
    Ignored:    docs/.DS_Store

Untracked files:
    Untracked:  docs/assets/Boettiger-2018-Ecology_Letters.pdf
    Untracked:  docs/assets/Packaging-Data-Analytical Work-Reproducibly-Using-R-and-Friends.pdf

Unstaged changes:
    Modified:   analysis/_site.yml
    Modified:   analysis/index.Rmd
    Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.
Expand here to see past versions:
    File Version Author Date Message
    html 921a7f8 annakrystalli 2018-10-30 commit docs
    Rmd f1468ac annakrystalli 2018-10-30 commit Rmd

Scholarship will be strengthened if we are more open with research materials, yet we lack conventions and technical infrastructure for such openness.

R packages can be used as a research compendium for organising and sharing files. R package structure is uniquely suitable to being easily adapted to solve problems of organising les and sharing them with other researchers. We describe how the conventional structure of R packages can be adapted for use as a research compendium, and illustrate this use with real-world examples.

Research Compendium? Three Generic Principles

  1. organize its les according to the prevailing conventions of the scholarly community: help other people recognize the structure of the project, and also support tool building which takes advantage of the shared structure.
  2. clear separation of data, method, and output, while unambiguously expressing the relationship between those three.
  3. A research compendium should specify the compu- tational environment that was used for the original analysis

History

This reproducible R Markdown analysis was created with workflowr 1.1.1