cholera (version 0.4.0)

addNeighborhood: Add expected neighborhood polygons

Description

In-development prototype.

Usage

addNeighborhood(pump.subset = NULL, pump.select = NULL, vestry = FALSE,
  weighted = TRUE, multi.core = FALSE, type = "area", color = NULL,
  alpha.level = 0.125, ...)

Arguments

pump.subset

Numeric. Vector of pumps to select (subset) from neighborhoods defined by "pump.select". Negative selection possible. NULL selects all pumps in "pump.select".

pump.select

Numeric. Numeric vector of pumps to define pump neighborhoods (i.e. the "population"). Negative selection possible. NULL selects all pumps.

vestry

Logical. TRUE uses the 14 pumps from the Vestry Report. FALSE uses the 13 in the original map.

weighted

Logical. TRUE computes shortest path weighted by road length. FALSE computes shortest path in terms of the number of nodes.

multi.core

Logical or Numeric. TRUE uses parallel::detectCores(). FALSE uses one, single core. You can also specify the number logical cores. On Window, only "multi.core = FALSE" is available.

type

Character. Type of annotation plot: "area", "border" or "street".

color

Character. Neighborhood color.

alpha.level

Numeric. Alpha level transparency: a value in [0, 1].

...

Additional plotting parameters.

See Also

snowMap, addIndexCase, addKernelDensity, addLandmarks, addPlaguePit, addVoronoi, addWhitehead

Examples

# NOT RUN {
# streetNameLocator("marshall street", zoom = TRUE, highlight = FALSE,
#   unit = "meter", cases = NULL)
# addNeighborhood(6:7)
# }