getTemplateStudyConfig: Create a study config template

Description Usage Arguments

View source: R/process_meta.R

Description

Create a study config template, returning config in list format and optionally writing config to yaml file. User may choose to set all parameters to NULL or to set any available default values.

Usage

1
2
3
getTemplateStudyConfig(study_dir = getwd(),
  set_default_directory_struct = TRUE, set_default_file_names = TRUE,
  study_name = NULL, writeYAML = TRUE)

Arguments

study_dir

root study directory, where CURRENT study dir will be created

set_default_directory_struct

logical; if TRUE, default study directory and subdirectories will be created

study_name

name of study

writeYAML

logical; write study config to YAML file


caitlinjones/halo documentation built on May 7, 2019, 8 a.m.