setup_output_dir: Set up output directories

View source: R/set_up_output_dir.r

setup_output_dirR Documentation

Set up output directories

Description

Set up bookdown manuscript and non-manuscript figure and table output directories. Creates directories, and saves objects specifying these directories into global environment. See prefix for details of objects saved.

Usage

setup_output_dir(dir_base = "_book", prefix = "dir_")

set_up_output_dir(dir_base = "_book", prefix = "dir_")

Arguments

dir_base

character. Path to base directory where objects are to be saved, relative to here::here(), i.e. the base directory is effectively here::here(dir_base). Default is "_book".

prefix

character. Prefix for naming objects specifying paths to particular directories. Default is dir_. This results in objects dir_manu, dir_manu_n, dir_manu_fig, dir_manu_tbl, dir_manu_n_fig and dir_manu_n_tbl, which provide the absolute paths. Corresponding objects ending in "_rel" (e.g. dir_manu_rel) specify the relative paths (relative to here::here()).

Value

invisible(TRUE). Side effects are the creation of directories and saving of objects specifying those directories to global environment.


MiguelRodo/reportutils documentation built on April 11, 2022, 3:32 p.m.