ss.options: Set or reset parameters to be used by SaTScan

In Kenkleinman/rsatscan: Tools, Classes, and Methods for Interfacing with SaTScan Stand-Alone Software

Description

Set or reset parameters to be used by SaTScan

Usage

ss.options(invals = NULL, reset = FALSE)

Arguments

invals	A list with entries of the form name=value, where value should be in quotes unless it is a number. Alternatively, may be a character vector whose entries are of the form "name=value". The "name" in either case should be a valid SaTScan parameter name; unrecognized names will generate a warning and will do nothing.
reset	If TRUE, will restore the default parameter values described in the "Details" section.

Details

ss.options() is intended to function like par() or options(). There is a default set of parameter settings that resembles the one used by SaTScan, except that it produces all possible output files and makes them as .dbf files instead of text.

Value

If invals == NULL, returns the current parameter set, as altered by previous calls to ss.options() since the last call with reset=TRUE. Otherwise returns modified parameter set invisibly. The side effect, if invals != NULL, is to set the current values of the parameters per the value of invals and reset.

Examples

## Not run: 
head(ss.options(),3)
ss.options(list(CaseFile="NYCfever.cas"))
head(ss.options(),3)

# reset; shows whole parameter file without invisible()
invisible(ss.options(reset=TRUE))
head(ss.options(),3)

## End(Not run)

Kenkleinman/rsatscan documentation built on May 27, 2019, 4:06 a.m.