options: Setting and displaying the options of the package

optionsR Documentation

Setting and displaying the options of the package

Description

Setting and displaying the options of the package

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:

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.

Value

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

Examples

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

IsoriX documentation built on Nov. 14, 2023, 5:09 p.m.