R/global-options.R

In constructive: Display Idiomatic Code to Construct Most R Objects

#' Global Options
#'
#' Set these options to tweak \{constructive\}'s global behavior, to set them
#' permanently you can edit your `.RProfile1`, e.g. using `usethis::edit_r_profile()`.
#'
#' * Set `options(constructive_print_mode = <character>)` to change the default
#'   value of the `print_mode` argument, of `print.constructive`, where `<character>` is a vector
#'     of strings among the following :
#'     * `"console"` : The default behavior, the code is printed in the console
#'     * `"script"` : The code is copied to a new R script
#'     * `"reprex"` : The code is shown in the viewer as a reprex,
#'     the reprex (not only the code!) is also copied to the clipboard.
#'     * `"clipboard"` : The constructed code is copied to the clipboard, if combined
#'     with `"reprex"` this takes precedence (the reprex is showed in the viewer,
#'     the code without output is copied to the clipboard)
#' * Set `options(constructive_opts_template = <list>)` to set default constructive options,
#'     see documentation of the `template` arg in `?construct`
#' * Set `options(constructive_pretty = FALSE)` to disable syntax highlighting.
#' 
#' ## Relevant options from other packages:
#' 
#' * `cli.code_theme` can be used to configure the syntax highlighting theme
#'   used by \{constructive\}; see [cli::code_theme_list()] for more information.
#'
#' @name constructive-global_options
#' @aliases constructive_opts_template constructive_pretty constructive_print_mode
NULL