knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Background

Code contents

Within this repository you will find:

| Directory | Description | | --------- | --------------------------------------------------------------------------- | | docs | Contains all .Rmds and their corresponding .htmls describing analyses performed for this project. These can be view interactively at: link| | logs | For any scripts that were run outside of an .Rmd (e.g. scripts from the scripts directory), a log file was recorded and can be accessed here. | | man | Figures used in .Rmds. | | R| Various functions called in docs and scripts. | | raw_data | External tables used in analyses. | | renv | renv-related scripts- | | results | Results from all analyses. | | scripts | Contains analysis scripts. Each script contains a one-line description and is also referenced in its corresponding .Rmd. |

Reproducibility

This repository uses renv to create a reproducible environment for this R project.

  1. When you first launches this project, renv should automatically bootstrap itself, thereby downloading and installing the appropriate version of renv into the project library.
  2. After this has completed, you can use renv::restore() to restore the project library locally on your machine.

For more information on collaborating with renv, please refer to this link.

License

The code in this repository is released under an MIT license. This repository is distributed in the hope that it will be useful to the wider community, but without any warranty of any kind. Please see the LICENSE file for more details.

Citation



RHReynolds/rmdplate documentation built on Feb. 3, 2023, 12:26 p.m.