setup_analysis_project: Set up analysis project folder and script files

View source: R/project_management.R

setup_analysis_projectR Documentation

Set up analysis project folder and script files

Description

Set up simple folder structure and template files for analysis project.

Usage

setup_analysis_project(
  folder = here::here(),
  analyses = c("data_prep", "analyses", "presentation"),
  pipeline_name = "outputs",
  code_folder = FALSE,
  standard_packages = c("magrittr", "here", "dplyr"),
  github_packages = NULL
)

Arguments

folder

Root folder of the project to be set up. Defaults to here::here()

analyses

Character vector of analysis steps. R files will be set up in order.

pipeline_name

Name of folder for outputs from each analysis step

code_folder

Logical. Should code files be placed in /code subfolder. Otherwise, are placed in root folder

standard_packages

Character vector of packages to be loaded at start of each analysis file.

github_packages

Character vector of packages to be loaded and installed from Github if needed at start of each analysis file.

Source

The structure is based on https://towardsdatascience.com/how-to-keep-your-research-projects-organized-part-1-folder-structure-10bd56034d3a, with some simplifications and additions.


LukasWallrich/rNuggets documentation built on Aug. 26, 2022, 11:03 a.m.