In ajhelmstetter/pulledRates: The Title of the Project

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

pulledRates

Research Compendium of the project {{ PLEASE ADD A FEW WORDS }}

How to cite

Please cite this compendium as:

{{ PLEASE ADD A CITATION }}

Content

This repository is structured as follow:

• data/: contains all raw data required to perform analyses

• rscripts/: contains R scripts to run each step of the workflow

• outputs/: contains all the results created during the workflow

• figures/: contains all the figures created during the workflow

• paper/: contains all the manuscript and related content (biblio, templates, etc.)

• R/: contains R functions developed especially for this project

• man/: contains help files of R functions

• DESCRIPTION: contains project metadata (author, date, dependencies, etc.)

• make.R: master R script to run the entire project by calling each R script stored in the rscripts/ folder

Usage

Clone the repository, open the .Rproj file in RStudio and run:

source("make.R")

Notes

• All required packages, listed in the DESCRIPTION file, will be installed (if necessary)
• All required packages and R functions will be loaded
• Some analyses listed in the make.R might take time

ajhelmstetter/pulledRates documentation built on April 26, 2024, 9:35 p.m.