README.md

In ahasverus/demo.compendium: The Title of the Project

demo.compendium

This repository was automatically created using the R package rcompendium and the function new_compendium(renv = TRUE, dockerfile = TRUE)

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

• analyses/: 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

• 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: main R script to run the entire project by calling each R script stored in the analyses/ folder

Usage

• Clone this repository
• Open a terminal
• Build the Docker image with:

docker build -t "demo.compendium" .

• Start a container based on this image:

docker run --rm -p 127.0.0.1:8787:8787 -e DISABLE_AUTH=true demo.compendium

• On a web browser enter this URL: 127.0.0.1:8787. A new RStudio Server instance will be available.
• To run the analysis:

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

ahasverus/demo.compendium documentation built on April 16, 2022, 3:02 p.m.