Learn R Programming

⚠️There's a newer version (2.0.0) of this package.Take me there.

SUMMER

Spatio-temporal Under-five Mortality Models of Estimation in R

Major update (version 0.3.0)

Version 0.3.0 contains some major updates from the previous versions. Some of the substantial change to existing functions are listed here. For a complete log of changes, see the News section.

Function name changes

The following functions have been renamed. Most of the function arguments remain the same:

  • countrySummary is now getDirect
  • cuontrySummary_mult is now getDirectList
  • fitspace is now fitGeneric
  • projINLA is now getSmooth

New functions

The following new functions are added:

  • getDiag: produce diagnostic plots for the fitted model.
  • getAdjusted: produce adjusted estimates for a fitted model
  • getAmat: automatic extract spatial adjacency matrix from the polygon file.
  • hatchPlot: plot variables on a map with hatching indicating the width of the credible interval.

New methods

fitINLA2: implements new smoothing methods based on binomial models at cluster level.

Installation - CRAN

The package is now available on CRAN. The easiest way to download is to install directly using the code below.

install.packages("SUMMER")

Installation - Development Version

To download the development version of the SUMMER package, use the code below.

# install.packages("devtools")
devtools::install_github("bryandmartin/SUMMER")

Usage

To see example usage of all main functions, build the package vignette. Note that the vignette will take a few minutes to compile.

# install.packages("devtools")
devtools::install_github("bryandmartin/SUMMER", build_vignettes = TRUE)
# Use this to view the vignette in the SUMMER HTML help
help(package = "SUMMER", help_type = "html")
# Use this to view the vignette as an isolated HTML file
utils::browseVignettes(package = "SUMMER")

Bug Reports / Change Requests

If you encounter a bug or would like make a change request, please file it as an issue here.

Random notes for package authors:

  • In order to use devtools::check to check the package with static vignettes, use the hidden option devtools::check(clean_doc = FALSE) to avoid deleting the inst/doc folder.
  • Also for large PDF vignette, run tools::compactPDF(gs_quality = "ebook", paths = "inst/doc/") to please CRAN.

Copy Link

Version

Install

install.packages('SUMMER')

Monthly Downloads

1,400

Version

0.3.0

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Zehang Li

Last Published

October 23rd, 2019

Functions in SUMMER (0.3.0)

getAdjusted

Adjust direct estimates and their associated variances
logit

Logit transformation
aggregateSurvey

Aggregate estimators from different surveys.
iid.new.pc

New random IID models for m-year to period random effects
getCounts

Aggregate person-month data into counts and totals by groups.
getBirths

Function to get Births file from DHS .dta files.
getDirectList

Obtain the Horvitz-Thompson direct estimates and standard errors using delta method for multiple surveys.
getSmoothed

Function to obtain projected estimates from INLA for each time and region.
fitINLA2

Fit cluster-level space-time smoothing models to mortality rates
fitINLA

Fit space-time smoothing models to mortality rates
getAmat

Extract adjacency matrix from the map
getDiag

Make diagnostic plots
mapPoints

Map GPS points to polygon regions
mapPlot

Makes map plot.
hatchPlot

Makes map plot with uncertainty hatching.
st.new

New Type I to IV space time interaction models for m-year to period random effects
st.new.pc

New Type I to IV space time interaction models for m-year to period random effects
iid.new

New random IID models for m-year to period random effects
getDirect

Obtain the Horvitz-Thompson direct estimates and standard errors using delta method for a single survey.
simhyper

Function to simulate hyperpriors from an adjacency matrix.
rw.new.pc

New random walk 1 and 2 models for m-year to period random effects
fitGeneric

Fit space-time smoothing models for a generic outcome from complex surveys.
plot.SUMMERproj

Plot projection output.
expit

Expit transformation
read_shape

Function to read shape files.
rw.new

New random walk 1 and 2 models for m-year to period random effects
rst

Simulate spatial and temporal random effects
ChangeRegion

Function to map region names to a common set.
DemoMap2

Map dataset for vignette.
KenData

Auxiliary data for Kenya 2014 DHS.
SUMMER-package

SUMMER package documentation.
DemoMap

Map dataset for vignette.
KingCounty

Map of King County
BRFSS

The BRFSS dataset
DemoData

Fake dataset for vignette.
DemoData2

Fake dataset for vignette.