stoRy (version 0.2.2)

stoRy_opt: Set stoRy package global options

Description

stoRy_opt() sets stoRy package global options.

Usage

stoRy_opt(x)

Arguments

x

A character string holding an option name. The possible values are "width", "print_min", and "print_max".

Details

The package options control the formatting of the Story(), Theme(), Collection(), and Themeset() R6 classes when printing to console. The options are as follows:

width:	The column width in characters of printed to console output (78 characters by default)
print_min:	The minimum number of entries to print to console (10 characters by default)
print_max:	The maximum number of entries to print to console (100 characters by default)

See Also

Use Story() to initialize an LTO thematically annotated story.

Use Theme() to initialize an LTO theme.

Use Collection() to initialize an collection of LTO thematically annotated stories.

Use Themeset() to initialize a set of related LTO themes.

Examples

if (FALSE) {
# Check the current option values:
stoRy_opt("width")
stoRy_opt("print_min")
stoRy_opt("print_max")

# Set the column width to 120 characters:
options(stoRy.width = 120L) 

# Set the minimum number of printed entries to be 25:
options(stoRy.print_min = 25L) 
 
# Set the maximum number of printed entries to be 250:
options(stoRy.print_max = 250L)
}