ss.options.extra: Add lines to the current SaTScan parameter list

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

Add lines to the current SaTScan parameter list

Description

Allows you to add arbitrary lines to the current set of SaTScan parameters

Usage

ss.options.extra(invals = NULL, section = NULL)

Arguments

invals	A character vector, which will be added to the current parameter list.
section	A character vector of length 1 that specifies the section of the parameter file to add the new parameters to. Sections are denoted in the 'ssenv' object by square brackets.

Details

For certain SaTScan models or inputs (multiple data sets, Polygon), SaTScan allows a variable number of parameters; these parameters are not used/allowed for other models or inputs. This function allows the user to add arbitrary lines to the current list of parameters. In addition to the options mentioned, it could also be used to add comments to the parameter file.

Value

Nothing.

Examples

## Not run: 
# Append second data file to the Multiple Data Sets section of the parameter list
ss.options.extra(invals=list(CaseFile2="NYCfever.cas"), section="Multiple Data Sets")
print(ss.options()[67:70])

# Can also append to the end of the parameter file by not specifying a section.
# This is useful for adding comments.
# Note that the input value can be specified as a character string instead of a list 
# just like 'ss.options()'
ss.options.extra(invals=";This is the end of the parameter list.")
tail(ss.options(), 3)

## End(Not run)

rsatscan documentation built on June 26, 2024, 5:08 p.m.