metayer environment variables and options
metayer-config.Rd
metayer environment variables and options
User facing configuration
When metayer is loaded, it populates several options and sets up logging. Much of this can be configured by making changes to config.yml.
configurability
Package configuration is specified in config.yml, which is designed to mimic the behavior of the config package. As such, the top-level sections--default, testing, and jupyter--are intended to correspond to an execution / operational mode. Our extension, config_get
, enables YAML references and provides a few default handlers for custom YAML tags.
custom YAML tags
Note that there are custom YAML tags available, !optenv
and !with_env
.
!optenv
optenv is used to evaluate simple R expressions, like logger::INFO
; the idea is to simplify the specification of objects or functions.
config.yml
logger
options
cli.default_handler
We set this to cli_nullity_handler
in order to enjoy null visibility in cli output.
cli.condition_unicode_bullets
Useful in testing to ensure that output doesn't have unusual unicode characters.
knitr.chunk.error
An aesthetic choice for R output.
A cosmetic change for imbuing R output with class tags suitable for CSS.
knitr.chunk.metayer_hook
A custom knitr options. Setting this enables sure_plot which requires a custom knitr hook (specified in .onLoad).
knitr.package.root.dir
The directory in which knitr will expect to find references. pkgdown and rmarkdown behavior can be quite sensitive to this.
mty.fig.*
with_grdev
default parameters. See the function reference.