Return path to profile-specific directory
projr_path_get_dir.RdReturns path to projr profile-specific directory.
Also creates the directory if it does not exist, and
ignores it if requested by _projr.yml.
Usage
projr_path_get_dir(
label,
...,
create = TRUE,
relative = FALSE,
absolute = FALSE,
safe = TRUE
)Arguments
- label
character. One of
"raw","cache","output","archive"and"docs". Class of directory to return. The"docs"option returns the path to the output directory frombookdown::render_book(as specified in"_bookdown.yml"), whereas the others returns paths as specified in"_projr.yml".- ...
Specifies sub-directory of directory returned. Passed to
file.path.- create
logical. If
TRUE, then the directory is created if it does not exist and it is ignored (or not) from.gitignoreand.Rbuildignoreas specified in_projr.yml. Default isTRUE.- relative
logical. If
TRUE, then forces that the returned path is relative to the project root. Default isFALSE.- absolute
logical. If
TRUE, then forces the returned path to be absolute. Default isFALSE.- safe
logical. If
TRUE, then the output directory is set to be"<path_to_cache>.output"instead of<path_to_output>(as specified in_projr.yml). The only time that this should be set toTRUEshould be when .build_outputis being run, as otherwise "development" or test runs will add to, delete or overwrite fabciles from the previous run of .build_output. Default isTRUE. Do not change this unless you know what you are doing.