whirl-options {whirl}R Documentation

Options for whirl

Description

verbosity_level

Verbosity level for functions in whirl. See zephyr::verbosity_level for details.

out_formats

Which log format(s) to produce. Possibilities are html, json, and markdown formats: gfm, commonmark, and markua.

track_files

Should files read and written be tracked? Currently only supported on Linux.

check_renv

Should the projects renv status be checked?

track_files_discards

List of file naming patterns not be tracked when track_files = TRUE

track_files_keep

List of file naming patterns always to be tracked when track_files = TRUE

approved_pkgs_folder

Approved folder library packages

approved_pkgs_url

Approved URL library packages

n_workers

Number of simultaneous workers used in the run function. A maximum of 128 workers is allowed.

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').

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.

wait_timeout

Timeout for waiting for the R process from callr::r_session to start, in milliseconds.


[Package whirl version 0.2.0 Index]