Skip to contents

WebmorphR default options

Source: R/wm_opts.R
wm_opts_defaults.Rd

Options set on load (unless they were already set by .Renviron)

  • overwrite ("ask"): Whether to overwrite images saved with write_stim() when in interactive mode; possible values are "ask" (ask if filenames exist), TRUE (always overwrite), and FALSE (never overwrite)

  • fill ("white"): the colour to use to fill image backgrounds

  • pt.color ("green") : the colour to use for points in draw_tem()

  • line.color ("blue"): the colour to use for lines in draw_tem()

  • plot ("inline"): whether to plot images inline in R markdown documents (set to any other value to just view them in the viewer)

  • plot.maxwidth (2400): The maximum width of images created by plot()

  • plot.maxheight (2400): The maximum height of images created by plot()

  • verbose (TRUE): Whether to produce verbose output and progress bars for long functions like auto_delin(), avg() or trans()

  • server ("https://webmorph.org"): The server to use for webmorph functions like avg() and trans(); do not change unless you've set up a local server

  • connection (stdin()): use internally for testing interactive functions; do not change

Usage

wm_opts_defaults()

Value

a list of default options

See also

wm_opts()

Examples

wm_opts_defaults() |> str() # view defaults
#> List of 10
#>  $ connection    : 'terminal' int 0
#>  $ fill          : chr "white"
#>  $ line.color    : chr "blue"
#>  $ overwrite     : chr "ask"
#>  $ plot          : chr "inline"
#>  $ plot.maxheight: num 2400
#>  $ plot.maxwidth : num 2400
#>  $ pt.color      : chr "green"
#>  $ server        : chr "https://webmorph.org"
#>  $ verbose       : logi TRUE

if (FALSE) {
# reset all options to default
wm_opts_defaults() |> wm_opts()
}