whirl-options-params: Internal parameters for reuse in functions

In whirl: Log Execution of Scripts

Internal parameters for reuse in functions

Description

Internal parameters for reuse in functions

Arguments

verbosity_level	Verbosity level for functions in whirl. See zephyr::verbosity_level for details.. Default: NA_character_.
out_formats	Which log format(s) to produce. Possibilities are html, json, and markdown formats: gfm, commonmark, and markua.. Default: "html".
track_files	Should files read and written be tracked? Currently only supported on Linux.. Default: FALSE.
check_renv	Should the projects renv status be checked?. Default: FALSE.
track_files_discards	List of file naming patterns not be tracked when track_files = TRUE. Default: c("^/lib", "^/etc", "^/lib64", "^/usr", "^/var", "^/opt", "^/sys", "^/proc", "^/tmp", "^/null", "^/urandom", "^/.cache").
track_files_keep	List of file naming patterns always to be tracked when track_files = TRUE. Default: NULL.
approved_pkgs_folder	Approved folder library packages. Default: NULL.
approved_pkgs_url	Approved URL library packages. Default: NULL.
n_workers	Number of simultaneous workers used in the run function. A maximum of 128 workers is allowed.. Default: 1.
log_dir	The output directory of the log files. Default is the folder of the executed script. log_dir can be a path as a character or it can be a function that takes the script path as input and returns the log directory. For more information see the examples of run() or vignette('whirl').. Default: function (x) dirname(x).
execute_dir	The working directory of the process executing each script. Default us to execute R files from the working directory when calling run() and all other functions from the directory of the script. To change provide a character path (used for all scripts) or a function that takes the script as input and returns the execution directory.. Default: NULL.
wait_timeout	Timeout for waiting for the R process from callr::r_session to start, in milliseconds.. Default: 9000.

Details

See whirl-options for more information.

whirl documentation built on April 16, 2025, 1:11 a.m.