Learn R Programming

sparr: Spatial and Spatiotemporal Relative Risk

The sparr package for R provides functions to estimate fixed and adaptive kernel-smoothed spatial relative risk surfaces via the density-ratio method and perform subsequent inference. Fixed-bandwidth spatiotemporal density and relative risk estimation is also supported.

Installation

This package is available on CRAN, and we recommend installing it from there using the standard

install.packages('sparr')

If you wish to live on the bleeding edge, you may install from github using devtools:

# install.packages("devtools")
devtools::install_github('tilmandavies/sparr')

Example

This is a basic example of relative risk estimation for primary biliary cirrhosis cases from north east England.

# Load library
library(sparr)
#> Loading required package: spatstat
#> Loading required package: spatstat.data
#> Loading required package: spatstat.geom
#> spatstat.geom 3.0-6
#> Loading required package: spatstat.random
#> spatstat.random 3.1-3
#> Loading required package: spatstat.explore
#> Loading required package: nlme
#> spatstat.explore 3.0-6
#> Loading required package: spatstat.model
#> Loading required package: rpart
#> spatstat.model 3.2-1
#> Loading required package: spatstat.linnet
#> spatstat.linnet 3.0-6
#> 
#> spatstat 3.0-3 
#> For an introduction to spatstat, type 'beginner'
#> 
#> 
#> Welcome to
#>    _____ ___  ____  ____  ____         
#>   / ___// _ \/ _  \/ __ \/ __ \        
#>   \__ \/ ___/ __  /  ___/  ___/        
#>  ___/ / /  / / / / /\ \/ /\ \          
#> /____/_/  /_/ /_/_/  \__/  \_\   v2.3-10
#> 
#> - type news(package="sparr") for an overview
#> - type help("sparr") for documentation
#> - type citation("sparr") for how to cite

# Load data on cases of primary biliary cirrhosis from north east England
data(pbc)

# Split into cases and controls
pbc_case <- split(pbc)$case
pbc_cont <- split(pbc)$control

# Estimate global bandwidth for smoothing
h0 <- OS(pbc, nstar="geometric")

# Compute a symmetric (pooled) adaptive relative risk estimate
# with tolerance contours
pbc_rr <- risk(pbc_case, pbc_cont, h0=h0, adapt=TRUE, tolerate=TRUE,
               hp=OS(pbc)/2, pilot.symmetry="pooled", davies.baddeley=0.05)
#> Estimating case density...
#> Done.
#> Estimating control density...Done.
#> Calculating tolerance contours...Done.

# And produce a plot
plot(pbc_rr)

Copy Link

Version

Install

install.packages('sparr')

Monthly Downloads

1,272

Version

2.3-16

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Tilman Davies

Last Published

March 20th, 2025

Functions in sparr (2.3-16)

LSCV.risk

Jointly optimal bandwidth selection for the spatial relative risk function
LIK.spattemp

Cross-validation bandwidths for spatiotemporal kernel density estimates
bivariate.density

Bivariate kernel density/intensity estimation
NS

Normal scale (NS) bandwidth selector
LIK.density

Cross-validation bandwidths for spatial kernel density estimates
SLIK.adapt

Simultaneous global/pilot likelihood bandwidth selection
OS

Oversmoothing (OS) bandwidth selector
available.h0

Available global bandwidth range
BOOT.spattemp

Bootstrap bandwidths for a spatiotemporal kernel density estimate
BOOT.density

Bootstrap bandwidth for a spatial kernel density estimate
rimpoly

Random point generation inside polygon
pbc

Primary biliary cirrhosis data
plot.bivden

Plotting sparr objects
multiscale.density

Multi-scale adaptive kernel density/intensity estimation
multiscale.slice

Slicing a multi-scale density/intensity object
burk

Burkitt's lymphoma in Uganda
fmd

Veterinary foot-and-mouth disease outbreak data
print.bivden

Printing sparr objects
risk

Spatial relative risk/density ratio
fft2d

2D fast-Fourier wrapper around 'fftwtools' or 'stats' package
spattemp.slice

Slicing a spatiotemporal object
tol.classplot

Plot tolerance contour classification scheme
sparr-internal

Internal sparr functions
tol.classify

Classification by p-value surfaces
tol.contour

Plot tolerance contours
spattemp.density

Spatiotemporal kernel density estimation
spattemp.risk

Spatiotemporal relative risk/density ratio
sparr-package

The sparr Package: Spatial and Spatiotemporal Relative Risk
summary.bivden

Summarising sparr objects
tolerance

Tolerance by p-value surfaces