exceedPlot: Plot exceedance probability of model results

In surveyPrev: Mapping the Prevalence of Binary Indicators using Survey Data in Small Areas

Plot exceedance probability of model results

Description

This function return a map of exceedance probability for given model results.

Usage

exceedPlot(
  x,
  exceed = TRUE,
  direction = 1,
  threshold = NA,
  geo = geo,
  by.geo = NULL,
  ylim = NULL,
  ...
)

Arguments

x	a model result using surveyPrev of class "fhModel" or "clusterModel"
exceed	direction of the comparison The default is exceed = TRUE, which correspond to probability of prevalence larger than the threshold. If exceed = FALSE, the plot computes probability smaller than the threshold.
direction	Direction of the color scheme. It can be either 1 (smaller values are darker) or -1 (higher values are darker). Default is set to 1.
threshold	the threshold to be used in computing the exceedance probability
geo	SpatialPolygonsDataFrame object for the map
by.geo	variable name specifying region names in the data
ylim	range of the values to be plotted.
...	additional arguments passed to SUMMER::mapPlot().

Value

This function returns a map showing probability of prevalence over/under the threshold.

Author(s)

Zehang Li, Qianyu Dong

Examples

## Not run: 

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info2 <- adminInfo(poly.adm = ZambiaAdm2,
                        admin = 2,
						   by.adm="NAME_2",
						   by.adm.upper = "NAME_1")
cl_res_ad2_unstrat <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)
ZambiaAdm2$admin2.name.full <- paste0(ZambiaAdm2$NAME_1,
									     "_",
										 ZambiaAdm2$NAME_2)
exceedPlot(cl_res_ad2_unstrat, threshold = 0.5,
			  exceed = TRUE, direction = -1,
			  geo = ZambiaAdm2, by.geo = "admin2.name.full")
exceedPlot(cl_res_ad2_unstrat, threshold = 0.5,
			  exceed = FALSE, direction = -1,
			  geo = ZambiaAdm2, by.geo = "admin2.name.full")


## End(Not run)

surveyPrev documentation built on June 19, 2026, 5:06 p.m.