nm_default_dirs: Setup analysis subdirectories

View source: R/NMproject-options.R

nm_default_dirsR Documentation

Setup analysis subdirectories

Description

[Stable]

This allows organisations/individuals with their own directory to customize their directory structure

Usage

nm_default_dirs(dir_list)

Arguments

dir_list

Optional named list or vector. Names "scripts" and "models" must be present. The rest can be unnamed.

Value

if dir_list is missing, will return value of getOption("nm_default_dirs") otherwise will set option nm_default_dirs.

Examples


orig_list <- nm_default_dirs()
orig_list

nm_default_dirs(list(
  models = "Models",
  scripts = "Scripts",
  results = "Results",
  source_data = "SourceData",
  derived_data = "Data"
))

nm_default_dirs()
nm_default_dirs(orig_list)




NMproject documentation built on Sept. 30, 2022, 1:06 a.m.