spiral_opt: Global options

spiral_optR Documentation

Global options

Description

Global options

Usage

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.

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.

Value

A list of options.

Examples

spiral_opt

spiralize documentation built on June 22, 2024, 10:45 a.m.