addNeighborhoodEuclidean {cholera}R Documentation

Add expected Euclidean pump neighborhoods.

Description

Add expected Euclidean pump neighborhoods.

Usage

addNeighborhoodEuclidean(pump.subset = NULL, pump.select = NULL,
  vestry = FALSE, case.location = "nominal", type = "star",
  alpha.level = 0.5, multi.core = TRUE, dev.mode = FALSE)

Arguments

pump.subset

Numeric. Vector of numeric pump IDs to subset from the neighborhoods defined by pump.select. Negative selection possible. NULL selects all pumps in pump.select.

pump.select

Numeric. Vector of numeric pump IDs 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.

case.location

Character. "address" or "nominal". "address" is the x-y coordinates of sim.ortho.proj. "nominal" is the x-y coordinates of regular.cases.

type

Character. Type of plot: "star", "area.points" or "area.polygons".

alpha.level

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

multi.core

Logical or Numeric. TRUE uses parallel::detectCores(). FALSE uses one, single core. You can also specify the number logical cores. See vignette("Parallelization") for details.

dev.mode

Logical. Development mode uses parallel::parLapply().

Value

R graphic elements.

Examples

## Not run: 
streetNameLocator("marshall street", zoom = 0.5, highlight = FALSE,
  add.subtitle = FALSE)
addNeighborhoodEuclidean()

streetNameLocator("marshall street", zoom = 0.5, highlight = FALSE,
  add.subtitle = FALSE)
addNeighborhoodEuclidean(type = "area.points")

## End(Not run)

[Package cholera version 0.7.5 Index]