option: option

View source: R/optional.R

optionR Documentation

option

Description

Make a variable optional.

option is an object wrapper which indicates whether the object is valid or not.

Usage

option(arg)

Arguments

arg

The variable to make optional

Details

Note that option(option(i)) == option(i) and option(none) == FALSE

Operators and print will have the same behavior with an optional than with its base type.

Value

arg as optional

See Also

none, opt_unwrap(), make_opt()

Examples

a <- option(5)
class(a)
## [1] "optional"

a == 5
## [1] TRUE

a
## [1] 5

antoinechampion/optional documentation built on May 6, 2022, 10:59 a.m.