spiral_opt: Global options

Description Usage Arguments Details Value Examples

View source: R/global.R

Description

Global options

Usage

1
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 following global parameters:

min_segment_len

Minimal length of the segment that partitions a curve.

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

1
2
# There is no example
NULL

spiralize documentation built on Feb. 6, 2022, 1:06 a.m.