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

In rsatscan: Tools for Running the External 'SaTScan' Software using R Classes and Methods

Add lines to the current SaTScan parameter list

Description

This function allows the user to add lines to the current list of parameters. It can be used to add parameters that are not allowed using the ss.options() function or to add comments to the parameter file.

Usage

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

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.
new.section	A logical variable indicating that a new section in the parameter file should be created. (default = FALSE)

Details

The SaTScan parameters and corresponding sections that must be added to the current parameter list using ss.options.extra() are listed below.

⁠Section=”Input”⁠
⁠Casefile-SourceLinelistFieldMap=⁠	Comma separated list of variables in the
	case input data to be included in the line
	list output file. For each variable,
	includes the column number, variable
	type, and variable name, separated by
	colons.
⁠Section=”Multiple Datasets”⁠
⁠[FileType][X]=⁠	Analogous to parameters in the Input
⁠[FileType][X]-SourceFieldMap=⁠	section, repeated for every additional
⁠[FileType][X]-SourceDelimiter=⁠	dataset, where [FileType] is CaseFile,
⁠[FileType][X]-SourceFirstRowHeader=⁠	ControlFile, or PopulationFile, and [X]
⁠[FileType][X]-SourceLinelistFieldMap=⁠	may be between 2 and 20.
⁠Section=”Polygons”⁠
⁠Polygon[X]=⁠	The bound region for each Polygon,
	when using the Continuous Poisson
	probability model.

Value

ss.options.extra() returns NULL and adds lines to the parameter set per the values of invals and section.

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])

# Specify columns in the case input file to be included in the line list output file 
ss.options.extra(invals=list('CaseFile-SourceLinelistFieldMap'=strwrap(
                                "0:0:\"IndividualID\",
                                 4:1:\"DescriptiveLongitude\",
                                 2:2:\"DescriptiveLatitude\",
                                 3:3:\"AGE\",
                                 1:3:\"GENDER\"")),
                 section="Input")

# 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 Jan. 26, 2026, 5:07 p.m.