Skip to content

rsatscan

1.0.10Package record

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

1packages depend
4.2Kdownloads / year
–test coverage
13/13flavors OK

Overview

About

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'.

Changes in 1.0.10
  • 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

CRAN checks
13OK
Slowest check: 1.5 min · r-release-macos-x86_64
Status changes
  • 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
Advisories

none known

Documentation

In release 1.0.10
READMEYes · 356 wordsVignettesYes · 2 · dynamicNEWSYes · 100% structured · mentions 1.0.10Citation fileNoWebsiteYes
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

4.2K
CRAN downloads in the past year
Rank #10,590 · ~11/day · ~349/mo
Daily download trend is not available in this view yet.
38530 days
98590 days
4.2K1 year
Compare downloads with other packages →
Also on96 r2u5 autocran114 c2d4u

Dependencies

Declared dependencies
3 external dependencies (excludes base and recommended)

Installing rsatscan adds no packages beyond those that come with R.

Depends (1)
R >= 3.0.2
Imports (2)
utilsforeign
LinkingTo (0)
none
Suggests (3)
Enhances (0)
none
Reverse dependencies
1direct
0indirect
Imports 1
Depends, Imports or LinkingTo, most downloaded first

Datasets

People & History

People (3)
Maintainer since 1.0.3 (2023) · added in 1.0.3
Contributor · added in 1.0.3

Previously maintained by Ken Kleinman (0.3.9122 to 0.3.9200).

Releases (10)

Pick two releases to compare their code metrics.

  • R
    R 4.6.0 released · 2026-04-24
  • 1.0.10Latest
    record
    2026-01-26 · current release · diff ↗
  • R
    R 4.5.0 released · 2025-04-11
  • 1.0.9
    record
    2025-04-08 · diff ↗
  • 1.0.8
    record
    2024-06-26 · diff ↗ ·
    added 1 export
    ss.options.extra
  • R
    R 4.4.0 released · 2024-04-24
  • 1.0.7
    record
    2023-10-24 · diff ↗
  • 1.0.6
    record
    2023-09-01 · diff ↗
  • 1.0.5
    record
    2023-06-21 · diff ↗
  • 1.0.4
    record
    2023-05-22 · diff ↗ ·
    added 1 export
    write.ntk
  • unarchivedReturned to CRAN
    2023-04-22
  • 1.0.3
    record
    2023-04-22 · diff ↗
  • R
    R 4.3.0 released · 2023-04-21
  • archivedRemoved from CRAN
    2022-06-14
    check problems were not corrected despite reminders
  • R
    R 4.2.0 released · 2022-04-22
  • R
    R 4.1.0 released · 2021-05-18
Show 9 earlier eventsHide 9 earlier events
  • R
    R 4.0.0 released · 2020-04-24
  • R
    R 3.6.0 released · 2019-04-26
  • R
    R 3.5.0 released · 2018-04-23
  • R
    R 3.4.0 released · 2017-04-21
  • R
    R 3.3.0 released · 2016-05-03
  • R
    R 3.2.0 released · 2015-04-16
  • 0.3.9200
    record
    2015-03-17 · diff ↗
  • 0.3.9122
    record
    2015-02-08
  • R
    R 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")
Hostovich, S., Kleinman, K., & Moosa, A. (2026). rsatscan: Tools for Running the External 'SaTScan' Software using R Classes and Methods (Version 1.0.10) [Computer software]. https://doi.org/10.32614/CRAN.package.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.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for rsatscan version 1.0.10 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

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.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy