Global options — spiral_opt • spiralize

Global options

spiral_opt(..., RESET = FALSE, READ.ONLY = NULL, LOCAL = FALSE, ADD = FALSE)

Arguments

...: Arguments for the parameters, see "details" section.
RESET: Whether to reset to default values.
READ.ONLY: Please ignore.
LOCAL: Please ignore.
ADD: Please ignore.

Value

A list of options.

Details

There are the following global parameters:

min_segment_len Minimal length of the segment that partitions a curve.
help Whether to print the help messages?

To access the value of an option: spiral_opt$name where name is the name of the option. To set a new value for an option: spiral_opt$name = new_value.

Examples

spiral_opt
#>  Option          Value             
#>  ---------------:--------------------
#>  min_segment_len 0.0174532925199433
#>  help            TRUE