# Small-Area-Estimation Unit/Area Models and Methods for Estimation in R

## Documentation for package ‘SUMMER’ version 2.0.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

adjustPopMat | Generating pixellated populations, and population frames
aggPixelPreds | Helper function of 'pixelPopToArea'
aggPop | Aggregate populations to the specified areal level
aggregateSurvey | Aggregate estimators from different surveys.
areaPopToArea | Aggregate populations to the specified areal level
Benchmark | Benchmark posterior draws to national estimates
BRFSS | The BRFSS dataset
calibrateByRegion | Calibrate the point level totals so their sum matches the regional totals
changeRegion | Map region names to a common set.
compareEstimates | Plot heatmap comparing pairwise posterior exceedence probabilities for svysae object
DemoData | Simulated child mortality person-month dataset.
DemoData2 | Simulated dataset for prevalence mapping.
DemoMap | Uganda Admin-1 region map for illustration purpose
DemoMap2 | Kenya Admin-1 region map for illustration purpose
easpaKenya | Kenya 2009 Census Frame and Related Datasets
easpaKenyaNeonatal | Kenya 2009 Census Frame and Related Datasets
expit | Expit transformation
getAdjusted | Adjust direct estimates and their associated variances
getAmat | Extract adjacency matrix from the map
getAreaName | Determines which administrative areas contain the given points
getBirths | Reformat full birth records into person-month format
getCounts | Aggregate person-month data into counts and totals by groups.
getDiag | Extract posterior summaries of random effects
getDirect | Obtain the Horvitz-Thompson direct estimates and standard errors using delta method for a single survey.
getDirectList | Obtain the Horvitz-Thompson direct estimates and standard errors using delta method for multiple surveys.
getExpectedNperEA | Internal functions for population simulation
getPoppsub | Generating pixellated populations, and population frames
getSmoothed | Extract smoothed estimates.
getSortIndices | Internal functions for population simulation
hatchPlot | Plot maps with uncertainty hatching.
iid.new | New random IID models for m-year to period random effects
iid.new.pc | New random IID models for m-year to period random effects
KenData | Auxiliary data for Kenya 2014 DHS.
kenyaPopulationData | Kenya 2009 Census Frame and Related Datasets
KingCounty | Map of King County
logit | Logit transformation
logitNormMean | Calculate the mean of a distribution whose logit is Gaussian
makePopIntegrationTab | Generating pixellated populations, and population frames
MalawiData | Auxiliary data for Malawi 2000, 2004, 2010, and 2015 DHS.
MalawiMap | Malawi Admin-2 map
mapEstimates | Mapping estimates for svysae object
mapPlot | Plot region-level variables on a map
mapPoints | Map GPS points to polygon regions
pixelPopToArea | Aggregate populations to the specified areal level
plot.SUMMERproj | Plot projection output.
poppaKenya | Kenya 2009 Census Frame and Related Datasets
poppRegionFromPopMat | Generate a population frame of a similar format to poppa argument of 'simPopCustom' with a custom set of regions
poppsubKenya | Kenya 2009 Census Frame and Related Datasets
print.SUMMERmodel | Print method for the smoothing models.
print.SUMMERmodel.svy | Print method for the smoothing models from 'smoothSurvey'.
print.SUMMERprojlist | Print method for the combined projection output.
projKenya | Map projection for Kenya
ridgePlot | Calculate and plot posterior densities of the projected estimates
rmultinom1 | Internal functions for population simulation
rMyMultinomial | Internal functions for population simulation
rMyMultinomialSubarea | Internal functions for population simulation
rst | Simulate spatial and temporal random effects
rStratifiedMultnomial | Internal functions for population simulation
rStratifiedMultnomialBySubarea | Internal functions for population simulation
rw.new | New random walk 1 and 2 models for m-year to period random effects
rw.new.pc | New random walk 1 and 2 models for m-year to period random effects
sampleNMultilevelMultinomial | Internal functions for population simulation
sampleNMultilevelMultinomialFixed | Internal functions for population simulation
setThresholdsByRegion | *[Experimental]*
simhyper | Simulate hyperpriors from an GMRF
simPop | Simulate populations and areal prevalences
simPopCustom | Simulate populations and areal prevalences
simPopInternal | Internal functions for population simulation
simPopSPDE | Simulate populations and areal prevalences
simSPDE | Simulate from the SPDE spatial model
smoothArea | Small area estimation via basic area level model
smoothCluster | Cluster-level space-time smoothing models for mortality rates
smoothDirect | Smoothed direct estimates for mortality rates
smoothSurvey | Fit space-time smoothing models for a binary outcome from complex surveys.
smoothUnit | Smooth via basic unit level model
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
summary.SUMMERmodel | Summary method for the smoothing models.
summary.SUMMERmodel.svy | Summary method for the smoothing model and output from 'smoothSurvey'.
summary.SUMMERprojlist | Summary method for the combined projection output. This function is the print method for class 'SUMMERprojlist'.
tcpPlot | Discrete-color maps based on the True Classification Probabilities