rsatscan: Tools for Running the External 'SaTScan' Software using R...
In rsatscan: Tools for Running the External 'SaTScan' Software using R Classes and Methods
rsatscan R Documentation
Tools for Running the External 'SaTScan' Software using R Classes and Methods.
Description
The 'SaTScan'(TM) https://www.satscan.org software uses spatial and
space-time scan statistics to detect and evaluate spatial and space-time clusters.
With the 'rsatscan' package, you can run the external SaTScan software from
within R using R data formats. To successfully select appropriate parameter
settings within 'rsatscan', you must first learn 'SaTScan'.
Details
The parameter files are constructed in R using the ss.options function and written
to the OS using the write.ss.prm function. SaTScan is run using the satscan
function. The satscan function returns a satscan-class object that has a
slot for every possible file that SaTScan makes, plus one for the parameter file you used
to generate the output.
The package also includes write.??? functions which will write case, control,
geography, population, etc., files in the format expected by SaTScan, if you happen to have
them (or make them) in R and want to write them into the OS for SaTScan to use.
There are summary and print methods for satscan-class
objects. There are also plot methods in the sf package, which
can be used if the sf package and sf packages are
installed and SaTScan generated a shapefile.
For a new analysis, always start with the SaTScan GUI to test parameter
settings, run an example analysis, etc. Once parameter settings are
finalized, open the parameter file in a text editor and use as a template for
defining each parameter in R syntax using the ss.options() or
ss.options.extra() function. For example, per R syntax, string values and
parameter names with special characters must be in quotes. See the
ss.options and ss.options.extra sections for more details.
Currently the package works with SaTScan >= 9.2 and has been tested on Windows 10.
Please contact the maintainer if you find success or trouble on other OSes.
Author(s)
Maintainer: Scott Hostovich HostovichS@imsweb.com
Authors:
Ken Kleinman ken.kleinman@gmail.com
Other contributors:
Amer Moosa MoosaA@imsweb.com [contributor]
See Also
Useful links:
rsatscan documentation built on Jan. 26, 2026, 5:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| rsatscan | R Documentation |
Tools for Running the External 'SaTScan' Software using R Classes and Methods.
Description
The 'SaTScan'(TM) https://www.satscan.org software uses spatial and space-time scan statistics to detect and evaluate spatial and space-time clusters. With the 'rsatscan' package, you can run the external SaTScan software from within R using R data formats. To successfully select appropriate parameter settings within 'rsatscan', you must first learn 'SaTScan'.
Details
The parameter files are constructed in R using the ss.options function and written
to the OS using the write.ss.prm function. SaTScan is run using the satscan
function. The satscan function returns a satscan-class object that has a
slot for every possible file that SaTScan makes, plus one for the parameter file you used
to generate the output.
The package also includes write.??? functions which will write case, control,
geography, population, etc., files in the format expected by SaTScan, if you happen to have
them (or make them) in R and want to write them into the OS for SaTScan to use.
There are summary and print methods for satscan-class
objects. There are also plot methods in the sf package, which
can be used if the sf package and sf packages are
installed and SaTScan generated a shapefile.
For a new analysis, always start with the SaTScan GUI to test parameter
settings, run an example analysis, etc. Once parameter settings are
finalized, open the parameter file in a text editor and use as a template for
defining each parameter in R syntax using the ss.options() or
ss.options.extra() function. For example, per R syntax, string values and
parameter names with special characters must be in quotes. See the
ss.options and ss.options.extra sections for more details.
Currently the package works with SaTScan >= 9.2 and has been tested on Windows 10. Please contact the maintainer if you find success or trouble on other OSes.
Author(s)
Maintainer: Scott Hostovich HostovichS@imsweb.com
Authors:
Ken Kleinman ken.kleinman@gmail.com
Other contributors:
Amer Moosa MoosaA@imsweb.com [contributor]
See Also
Useful links:
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.