The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.
The geostan R package supports a complete spatial analysis workflow with Bayesian models for areal data, including a suite of functions for visualizing spatial data and model results. geostan models were built using Stan, a state-of-the-art platform for Bayesian modeling. The package is designed partly for public health research with spatial data, for which it complements the surveil R package for time series analysis of public health surveillance data.
Features include:
Using your R console, you can install geostan from CRAN:
install.packages("geostan")
Or, you can install the latest version from the package github repository:
if (!require('devtools')) install.packages('devtools')
::install_github("connordonegan/geostan") devtools
If you are using Windows and installing with
install_github
, you may need to install Rtools first
(this is not needed when installing from CRAN). To install Rtools:
.exe
file you just downloaded and
double-click to begin installation of Rtools.All functions and methods are documented (with examples) on the website reference page. See the package vignettes for more on exploratory spatial analysis, spatial measurement error models, spatial regression with raster layers, and building custom spatial model in Stan.
To ask questions, report a bug, or discuss ideas for improvements or new features please visit the issues page, start a discussion, or submit a pull request.
Load the package and the georgia
county mortality data
set:
library(geostan)
#> This is geostan version 0.6.0
data(georgia)
This has county population and mortality data by sex for ages 55-64, and for the period 2014-2018. As is common for public access data, some of the observations missing because the CDC has censored them.
The sp_diag
function provides visual summaries of
spatial data, including a histogram, Moran scatter plot, and map. Here
is a visual summary of crude female mortality rates (as deaths per
10,000):
<- shape2mat(georgia, style = "B")
A <- georgia$rate.female * 10e3
mortality_rate sp_diag(mortality_rate, georgia, w = A)
#> 3 NA values found in x will be dropped from data x and matrix w
#> Warning: Removed 3 rows containing non-finite outside the scale range
#> (`stat_bin()`).
The following code fits a spatial conditional autoregressive (CAR)
model to female county mortality data. These models are used for
estimating disease risk in small areas like counties, and for analyzing
covariation of health outcomes with other area qualities. The R syntax
for fitting the models is similar to using lm
or
glm
. We provide the population at risk (the denominator for
mortality rates) as an offset term, using the log-transform. In this
case, three of the observations are missing because they have been
censored; per CDC criteria, this means that there were 9 or fewer deaths
in those counties. By using the censor_point
argument and
setting it to censor_point = 9
, the model will account for
the censoring process when providing estimates of the mortality
rates:
<- prep_car_data(A)
cars #> Range of permissible rho values: -1.661134 1
<- stan_car(deaths.female ~ offset(log(pop.at.risk.female)),
fit censor_point = 9,
data = georgia,
car_parts = cars,
family = poisson(),
cores = 4, # for multi-core processing
refresh = 0) # to silence some printing
#> 3 NA values identified in the outcome variable
#> Found in rows: 55, 126, 157
#>
#> *Setting prior parameters for intercept
#> Distribution: normal
#> location scale
#> 1 -4.7 5
#>
#> *Setting prior for CAR scale parameter (car_scale)
#> Distribution: student_t
#> df location scale
#> 1 10 0 3
#>
#> *Setting prior for CAR spatial autocorrelation parameter (car_rho)
#> Distribution: uniform
#> lower upper
#> 1 -1.7 1
Passing a fitted model to the sp_diag
function will
return a set of diagnostics for spatial models:
sp_diag(fit, georgia, w = A)
#> Using sp_diag(y, shape, rates = TRUE, ...). To examine data as (unstandardized) counts, use rates = FALSE.
#> 3 NA values found in x will be dropped from data x and matrix w
#> Warning: Removed 3 rows containing missing values or values outside the scale
#> range (`geom_pointrange()`).
The print
method returns a summary of the probability
distributions for model parameters, as well as Markov chain Monte Carlo
(MCMC) diagnostics from Stan (Monte Carlo standard errors of the mean
se_mean
, effective sample size n_eff
, and the
R-hat statistic Rhat
):
print(fit)
#> Spatial Model Results
#> Formula: deaths.female ~ offset(log(pop.at.risk.female))
#> Spatial method (outcome): CAR
#> Likelihood function: poisson
#> Link function: log
#> Residual Moran Coefficient: 0.00123875
#> WAIC: 1228.29
#> Observations: 156
#> Data models (ME): none
#> Inference for Stan model: foundation.
#> 4 chains, each with iter=2000; warmup=1000; thin=1;
#> post-warmup draws per chain=1000, total post-warmup draws=4000.
#>
#> mean se_mean sd 2.5% 20% 50% 80% 97.5% n_eff Rhat
#> intercept -4.666 0.007 0.143 -4.840 -4.729 -4.672 -4.616 -4.484 461 1.006
#> car_rho 0.924 0.001 0.059 0.778 0.884 0.937 0.973 0.996 3086 1.001
#> car_scale 0.456 0.001 0.036 0.390 0.427 0.454 0.485 0.533 3776 1.000
#>
#> Samples were drawn using NUTS(diag_e) at Tue Apr 16 08:52:52 2024.
#> For each parameter, n_eff is a crude measure of effective sample size,
#> and Rhat is the potential scale reduction factor on split chains (at
#> convergence, Rhat=1).
Applying the fitted
method to the fitted model will
return the fitted values from the model - in this case, the fitted
values are the estimates of the county mortality rates. Multiplying them
by 10,000 gives mortality rate per 10,000 at risk:
<- fitted(fit) * 10e3
mortality_est <- georgia$NAME
county_name head( cbind(county_name, mortality_est) )
#> county_name mean sd 2.5% 20% 50%
#> fitted[1] Crisp 101.64998 9.384722 84.24670 93.71233 101.29406
#> fitted[2] Candler 137.17952 16.264992 107.11368 123.59204 136.39838
#> fitted[3] Barrow 94.22368 6.126884 82.75981 89.00941 94.11519
#> fitted[4] DeKalb 59.76170 1.595148 56.68882 58.40064 59.76835
#> fitted[5] Columbia 53.36728 3.265343 47.21909 50.61056 53.33728
#> fitted[6] Cobb 54.13621 1.545304 51.09988 52.81882 54.11181
#> 80% 97.5%
#> fitted[1] 109.51372 120.80189
#> fitted[2] 150.22007 171.23752
#> fitted[3] 99.29052 106.43936
#> fitted[4] 61.09047 62.90342
#> fitted[5] 56.01686 60.00058
#> fitted[6] 55.46060 57.14337
The mortality estimates are stored in the column named “mean”, and the limits of the 95% credible interval are found in the columns “2.5%” and “97.5%”.
Details and demonstrations can be found in the package help pages and vignettes.
If you use geostan in published work, please include a citation.
Donegan, Connor (2022) “geostan: An R package for Bayesian spatial analysis” The Journal of Open Source Software. 7, no. 79: 4716. https://doi.org/10.21105/joss.04716.
@Article{,
title = {{geostan}: An {R} package for {B}ayesian spatial analysis},
author = {Connor Donegan},
journal = {The Journal of Open Source Software},
year = {2022},
volume = {7},
number = {79},
pages = {4716},
doi = {10.21105/joss.04716},
}
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.