setup_analysis: Setup data analysis folder

In CCMH-PSU/CCMHr: CCMH Data Cleaning

Setup data analysis folder

Description

Setup data analysis folder

Usage

setup_analysis(
  name,
  data.folder = TRUE,
  data.folder.rawclean = TRUE,
  visuals.folder = TRUE,
  R.folder = TRUE,
  add.date = TRUE,
  add.folder = NULL,
  add.rfiles = TRUE,
  create.rproj = TRUE
)

Arguments

name	A string to indicate the name of the main folder.
data.folder	A logical statement to add data subfolder to the main folder. Default is TRUE.
data.folder.rawclean	A logical statement to add raw and clean subfolder within the data subfolder. Default is TRUE.
visuals.folder	A logical statement to add visuals subfolder to the main folder. Default is TRUE.
R.folder	A logical statement to add R subfolder to the main subfolder. Default is TRUE.
add.date	A logical statement to add the date to the main folder name. Format is Year-Month (numeric). Default is TRUE.
add.folder	A string or vector list with the names of additional folders to be added to the main and subfolders. When creating a folder that will contain subfolder(s), make sure the main folder is listed before the subfolder(s). Default is NULL.
add.rfiles	A logical statement to add R files based on templates to the R folder. Default is TRUE.
create.rproj	A logical statement to create a .Rproj file in the main folder. Default is TRUE.

Value

A analysis folder and R syntax files to conduct data analysis.

CCMH-PSU/CCMHr documentation built on Jan. 11, 2025, 4:36 p.m.