View source: R/cctu_initialise.R
cctu_initialise | R Documentation |
initialise objects for using cctu package
cctu_initialise(root = getwd(), scripts = FALSE, rm = FALSE)
cctu_initialize(root = getwd(), scripts = FALSE, rm = FALSE)
cctu_check_dir(root = getwd(), warnings = FALSE)
rm_output(
root_output = "Output",
core = TRUE,
figures = TRUE,
reports = TRUE,
output = TRUE
)
root |
the root directory to start in |
scripts |
logical create the standard set of scripts. Intended to be used once interactively at the start of coding for an analysis. |
rm |
logical whether to also run |
warnings |
logical indicator to issue warning if the directories do not exist. Default FALSE. |
root_output |
character giving the output directory path |
core |
logical delete the files in /Core |
figures |
logical delete the files /Figures |
reports |
logical delete the files in /Reports |
output |
logical delete top level files in |
cctu_initialise gives an invisible return of logical indicating if the directories have been created. The directories needed are "Output", and within "Output", "Core", "Figures", "Reports".
It also runs reset_code_tree(root)
automatically.
cctu_check_dir gives a logical indicating if the directories exist,
cctu_initialise()
: create the standard directories for outputs if needed.
cctu_initialize()
: identifical function with American spelling
cctu_check_dir()
: Check if the directories exist for cctu
rm_output()
: function to clear previous output files, but leaves the directories in place
dir.create
reset_code_tree
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.