write.ss.prm: Write the SaTScan parameter file

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

Write the SaTScan parameter file

Description

Writes the current set of SaTScan parameters to a specified location in the OS.

Usage

write.ss.prm(location, filename, matchout = TRUE)

Arguments

location	A directory location, excluding the trailing "/".
filename	The name of the file to be written to the OS; The extension ".prm" will be appended.
matchout	If false, the ResultsFile parameter will not be touched; note that this will likely result in undesirable performance from calls to satcan() using the parameter file. If true, the ResultsFile is reset to share the filename given here.

Details

The current SaTScan options can be reset or modified ss.options() and/or ss.options.extra(). Once they are set as desired, they can be written to the OS using this function.

Value

Nothing. (Invisibly.) Side effect is to write a file in the OS.

See Also

ss.options, ss.options.extra

Examples

## Not run: 
## Would write the current ss.options() to c:/temp/NYCfever.prm
write.ss.prm("c:/tmp","NYCfever")

## End(Not run)

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