Package: rsatscan 1.0.10

Scott Hostovich

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

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

Authors:Ken Kleinman [aut], Scott Hostovich [cre], Amer Moosa [ctb]

rsatscan_1.0.10.tar.gz
rsatscan_1.0.10.tar.gz(r-4.7-any)rsatscan_1.0.10.tar.gz(r-4.6-any)
rsatscan_1.0.10.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
rsatscan/json (API)

# Install 'rsatscan' in R:
install.packages('rsatscan', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))
Datasets:
  • NHumbersidecas - North Humberside leukemian and lymphoma example- cases
  • NHumbersidectl - North Humberside leukemian and lymphoma example- controls
  • NHumbersidegeo - North Humberside leukemian and lymphoma example- geography
  • NMcas - New Mexico Brain Cancer example- cases
  • NMgeo - New Mexico Brain Cancer example- geography
  • NMpop - New Mexico Brain Cancer example- population
  • NYCfevercas - New York City Fever example- cases
  • NYCfevergeo - New York City Fever example- geography

On CRAN:

Conda:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

5.69 score 10 stars 49 scripts 378 downloads 10 mentions 15 exports 1 dependencies

Last updated from:282d60b769. Checks:4 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK120
source / vignettesOK159
linux-release-x86_64OK110
wasm-releaseOK139

Exports:satscanss.optionsss.options.extrawrite.adjwrite.caswrite.ctlwrite.geowrite.grdwrite.hawrite.maxwrite.metwrite.nbrwrite.ntkwrite.popwrite.ss.prm

Dependencies:foreign

rsatscan
Space-Time Permutation example: NYC fever data | Poisson spatio-temporal example: New Mexico brain tumor data | Bernoulli purely spatial example: North Humberside leukemia and lymphoma
Rendered fromrsatscan.Rmdusingknitr::rmarkdown

Last update: 2026-01-26
Started: 2015-01-09

Simulation experiments with SaTScan and rsatscan
Rendered fromsimulation.Rmdusingknitr::rmarkdown

Last update: 2026-01-26
Started: 2015-01-09

Readme and manuals

Help Manual

Help pageTopics
Change list version of paramaters into char vectorcharlistopts
North Humberside leukemian and lymphoma example- casesNHumbersidecas
North Humberside leukemian and lymphoma example- controlsNHumbersidectl
North Humberside leukemian and lymphoma example- geographyNHumbersidegeo
New Mexico Brain Cancer example- casesNMcas
New Mexico Brain Cancer example- geographyNMgeo
New Mexico Brain Cancer example- populationNMpop
New York City Fever example- casesNYCfevercas
New York City Fever example- geographyNYCfevergeo
Methods for satscan-class objectsprint.satscan
Read SaTScan output filesread.col
Read SaTScan output filesread.gis
Read SaTScan output filesread.llr
Read SaTScan output filesread.rr
Read SaTScan output filesread.satscanmain
Read SaTScan output filesread.sci
Tools for Running the External 'SaTScan' Software using R Classes and Methods.rsatscan-package rsatscan
Run SaTScan in the OSsatscan
find earliest SaTScan parameter set that contains specified parametersearch_for_param
Set or reset parameters to be used by SaTScanss.options
Add lines to the current SaTScan parameter listss.options.extra
Substitute new values into the input objectsubin
Methods for satscan-class objectssummary.satscan
Write a SaTScan adj filewrite.adj
Write a SaTScan cas (case) filewrite.cas
Write a SaTScan ctl (control) filewrite.ctl
Write a SaTScan geo filewrite.geo
Write a SaTScan grd (grid) filewrite.grd
Write a SaTScan ha (alternative hypothesis) filewrite.ha
Write a SaTScan max filewrite.max
Write a SaTScan met filewrite.met
Write a SaTScan nbr (neighbor) filewrite.nbr
Write a SaTScan ntk (network) filewrite.ntk
Write a SaTScan pop (population) filewrite.pop
Write the SaTScan parameter filewrite.ss.prm