options: Setting and displaying the options of the package

In IsoriX: Isoscape Computation and Inference of Spatial Origins using Mixed Models

Setting and displaying the options of the package

Description

** Information on the settings for the delta notation **

Usage

options_IsoriX(...)

getOption_IsoriX(x = NULL)

Arguments

...

A named value or a list of named values. The following values, with their defaults, are used: title_delta_notation a name, call, or expression used as default in titles to refer to the delta notation. example_maxtime The number of seconds allowed for a given example to run. It is used to control whether the longer examples should be run or not based on the comparison between this option and the approximate running time of the example on our computers. Ncpu An integer corresponding to the number of cores to be used (in functions that can handle parallel processing). dont_ask A logical indicating if the user prompt during interactive session during plotting must be inactivated (for development purposes only). spaMM_debugmod A logical indicating if the warnings and errors produced by the spaMM package should stopped being turned into messages (for development purposes only).

x

A character string holding an option name.

Details

Note that if the delta notation is not successfully rendered on your plots (which can happen for various reasons related to fonts, encoding settings, graphic devices and perhaps more), you may try to use e.g. options_IsoriX(title_delta_notation = bquote(italic("\u03B4")**2*H[p])) to override the default for all plots. The default does correspond to options_IsoriX(title_delta_notation = bquote(delta**2*H)). If you are working with oxygen (rather than with deuterium), modifying the global option is also a good place to do so. You may do: options_IsoriX(title_delta_notation = bquote(delta**18*O)).

Value

The options are invisibly returned in an object called IsoriX:::.data_IsoriX$options

Examples

OldOptions <- options_IsoriX()
OldOptions
getOption_IsoriX("title_delta_notation")
getOption_IsoriX("example_maxtime")
options_IsoriX(example_maxtime = 30)
options_IsoriX()
options_IsoriX(example_maxtime = OldOptions$example_maxtime)
options_IsoriX()

IsoriX documentation built on Sept. 11, 2024, 8:22 p.m.