voptions: Set or get options globally or per object.

voptionsR Documentation

Set or get options globally or per object.

Description

There are three ways to specify options for this package.

  • Globally. Setting voptions(option1=value1,option2=value2,...) sets global options.

  • Per object. Setting voptions(x=<object>, option1=value1,...), causes all relevant functions that use that object (e.g. confront) to use those local settings.

  • At execution time. Relevant functions (e.g. confront) take optional arguments allowing one to define options to be used during the current function call

Usage

voptions(x = NULL, ...)

## S4 method for signature 'ANY'
voptions(x = NULL, ...)

validate_options(...)

reset(x = NULL)

## S4 method for signature 'ANY'
reset(x = NULL)

## S4 method for signature 'expressionset'
voptions(x = NULL, ...)

## S4 method for signature 'expressionset'
reset(x = NULL)

Arguments

x

(optional) an object inheriting from expressionset such as validator or indicator.

...

Name of an option (character) to retrieve options or option = value pairs to set options.

Value

When requesting option settings: a list. When setting options, the whole options list is returned silently.

Options for the validate package

Currently the following options are supported.

  • na.value (NA,TRUE,FALSE; NA) Value to return when a validating statement results in NA.

  • raise ("none","error","all"; "none") Control if the confront methods catch or raise exceptions. The 'all' setting is useful when debugging validation scripts.

  • lin.eq.eps ('numeric'; 1e-8) The precision used when evaluating linear equalities. To be used to control for machine rounding.

  • "reset" Reset to factory settings.

See Also

Other expressionset-methods: as.data.frame,expressionset-method, as.data.frame(), created(), description(), label(), meta(), names<-,rule,character-method, origin(), plot,validator-method, summary(), variables()

Other expressionset-methods: as.data.frame,expressionset-method, as.data.frame(), created(), description(), label(), meta(), names<-,rule,character-method, origin(), plot,validator-method, summary(), variables()

Examples


# set an option, local to a validator object:
v <- validator(x + y > z)
voptions(v,raise='all')
# check that local option was set:
voptions(v,'raise')
# check that global options have not changed:
voptions('raise')

validate documentation built on March 24, 2022, 5:07 p.m.