isa.option: Options for the isa package

In isa2: The Iterative Signature Algorithm

Options for the isa package

Description

This function can be used to set various options that affect many functions in the isa package.

Usage

isa.option(...)

Arguments

...	A single option query, or option assignments, these must be named, too. See details below.

Details

The isa.option function can be used in three forms. First, calling it without any arguments returns a named list of the current values of all isa options.

Second, calling it with a character scalar as the single argument, it returns the value of the specified option.

Third, calling it with a named argument (or more named arguments) set the specified options to the given values.

Here is a list of all the currently supported options:

verbose

Logical scalar. Whether to report what the isa functions are currently doing. Defaults to FALSE.

status.function

A function object, it serves as a callback for printing status messages.

Value

In the first form, isa.option returns a named list with the current values of all options.

In the second form, it returns the value of the specified option.

In the third form, it returns a named list with the current values of all options, invisibly.

Author(s)

Gabor Csardi [e-mail]

Examples

## Make isa functions verbose
isa.option(verbose=TRUE)

## Query the value of 'verbose'
isa.option("verbose")

## Query all options
isa.option()

isa2 documentation built on March 7, 2023, 8:16 p.m.