Learn R Programming

sandwichr: Spatial prediction based on spatial stratified heterogeneity

sandwichr is an R package for spatial prediction based on the spatial stratified heterogeneity (SSH) theory, which enables users to:

  • Interpolate the sampling attribute over the reporting units that does not rely on spatial autocorrelation;
  • Assess the prediction uncertainties through standard errors and confidence intervals;
  • Evaluate the overall accuracy using a diagnostic statistic called the k-fold cross validation estimate.

You may also find this package on CRAN: https://cran.r-project.org/web/packages/sandwichr/.

Getting setup with R

Using the sandwichr package requires a recent version of R to be installed on your computer. The easiest way is to install it through CRAN , which stands for the Comprehensive R Archive Network.

Once R is installed, you can proceed to install the RStudio Integrated Development Environment (IDE) to have a much improved environment to work with R. Here is detailed description of RStudio. It is free to download on https://posit.co/download/rstudio-desktop/#download/.

Installing the package

Now you have the base R and a nice IDE installed on your computer, you can navigate to the console window (in RStudio, the bottom left panel) and install the sandwichr package by executing the following lines of code:

install.packages("sandwichr")

Tutorial

Once you install the package, we strongly recommend you going through a tutorial of this package to explore it in different scenarios of use. You can find it using the argument:

browseVignettes("sandwichr")

Citation

Please cite the following reference if you use the code. We are also working on an article about this particular software.

@article{Wang+Haining+Liu+Li+Jiang:2013,
    author = {Jin-Feng Wang and Robert Haining and Tie-Jun Liu and Lian-Fa Li and Cheng-Sheng Jiang},
    title ={Sandwich Estimation for Multi-Unit Reporting on a Stratified Heterogeneous Surface},
    journal = {Environment and Planning A: Economy and Space},
    volume = {45},
    number = {10},
    pages = {2515-2534},
    year = {2013},
    doi = {10.1068/a44710}
}

Contacts

If there are any questions or suggestions (or anything else you want to talk about concerning this project), please feel free to let us know! If you have found a bug, you can also file an issue.

Email: lin.3326@osu.edu (Ms Yue Lin), xucd@lreis.ac.cn (Dr Chengdong Xu), wangjf@lreis.ac.cn (Dr Jinfeng Wang*)

State Key Laboratory of Resources and Environmental Information System
Institute of Geographic Sciences and Natural Resources Research
Chinese Academy of Sciences
Beijing, 100101, China

Copy Link

Version

Install

install.packages('sandwichr')

Monthly Downloads

15

Version

1.0.4

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Yue Lin

Last Published

April 26th, 2023

Functions in sandwichr (1.0.4)

autoplot

Plot prediction results
bc.data

Breast cancer incidence in mainland China
ssh.data.txt

Prepare text data for Geodetector
load.data.txt

Load text files into data frames
sim.data

Simulated data
sandwich.model

Perform Sandwich model-based mapping
sandwichr

sandwichr: Spatial Prediction Based on Spatial Stratified Heterogeneity
sandwich.cv

Perform k-fold cross validation
load.data.shp

Load shapefiles into sfs
ssh.data.shp

Prepare shapefile data for Geodetector
ssh.test

Evaluate stratification
summary

Summarize prediction results