Tools for Running the External 'SaTScan' Software using R Classes and Methods
Overview
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'.
- satscan() now extracts results file name from parameter list. This eliminates the requirement that the results file have the same name as the parameter file.
- Fixed an error that occured when summary.satscan() was called on a satscan object without cluster information.
- SaTScan 10.3 parameter 'MostLikelyClusterEachCentroidDBase' has been set to 'y' by default to be in line with previous versions.
- Added an empty 'Polygons' section to the SaTScan 10.3 parameter list. Parameters can be added to it using ss.options.extra().
- Updated documentation README, package description, and rsatscan.Rmd vignette to give better instructions on how to begin a new analysis.
- Updated warning message in ss.options() if parameter is not found to suggest that the parameter might need to be specified using ss.options.extra().
- Added 'new.section' parameter to ss.options.extra() to create a new section of the parameter file.
- Updated documentation for ss.options() and ss.options.extra().
- Added table of parameters which must be specified with ss.options.extra() into ss.options() help page.
- Added warning message in satscan() function if SaTScan executable has an error and 'verbose' = FALSE. ** Windows 10 with SaTScan 10.3, R 4.5.1
From NEWS in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK12 OK, 1 FAILURE2026-06-08
- WARNING12 OK, 1 WARNING2026-06-07
- OK13 OK2026-05-01
Show 2 earlier changesHide 2 earlier changes
- WARNING13 OK, 1 WARNING2026-03-21
- OK14 OK2026-03-10
Documentation
- Help pages
- 35includes a package overview page
- Examples that run
- 0%3 never run · 1 hold no code
- Exported functions with examples
- 27%
- Documented parameters
- 100%
- Return-value docs
- 27%
- Help pages citing references
- 0%
Downloads
Dependencies
Installing rsatscan adds no packages beyond those that come with R.
Code & Tests
Datasets
People & History
Previously maintained by Ken Kleinman (0.3.9122 to 0.3.9200).
Pick two releases to compare their code metrics.
- RR 4.6.0 released · 2026-04-24
- 1.0.10Latest
- RR 4.5.0 released · 2025-04-11
- 1.0.92025-04-08 · diff ↗
- 1.0.8
- RR 4.4.0 released · 2024-04-24
- 1.0.72023-10-24 · diff ↗
- 1.0.62023-09-01 · diff ↗
- 1.0.52023-06-21 · diff ↗
- 1.0.4
- unarchivedReturned to CRAN2023-04-22
- 1.0.32023-04-22 · diff ↗
- RR 4.3.0 released · 2023-04-21
- archivedRemoved from CRAN2022-06-14check problems were not corrected despite reminders
- RR 4.2.0 released · 2022-04-22
- RR 4.1.0 released · 2021-05-18
Show 9 earlier eventsHide 9 earlier events
- RR 4.0.0 released · 2020-04-24
- RR 3.6.0 released · 2019-04-26
- RR 3.5.0 released · 2018-04-23
- RR 3.4.0 released · 2017-04-21
- RR 3.3.0 released · 2016-05-03
- RR 3.2.0 released · 2015-04-16
- 0.3.92002015-03-17 · diff ↗
- 0.3.91222015-02-08
- RR 3.1.0 released · 2014-04-10
Package metadata
- First published
- 2015-02-08
- Total releases
- 10 / 11 yrs
- License
- GPL-3 OSI
- Minimum R
- ≥ 3.0.2
- Bundled data
- 16 KB / 8 files
- Download size
- 66 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("rsatscan")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.