addNeighborhoodWalking {cholera}R Documentation

Add expected walking neighborhoods.

Description

Add expected walking neighborhoods.

Usage

addNeighborhoodWalking(pump.subset = NULL, pump.select = NULL,
  vestry = FALSE, weighted = TRUE, path = NULL, path.color = NULL,
  path.width = 3, alpha.level = 0.25, polygon.type = "solid",
  polygon.col = NULL, polygon.lwd = 2, 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 uses all pumps in pump.select.

pump.select

Numeric. Numeric vector of pump IDs that define which pump neighborhoods to consider (i.e., specify 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.

path

Character. "expected" or "observed".

path.color

Character. Use a single color for all paths. NULL uses neighborhood colors defined by snowColors().

path.width

Numeric. Set width of paths.

alpha.level

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

polygon.type

Character. "perimeter" or "solid".

polygon.col

Character.

polygon.lwd

Numeric.

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().

Examples

## Not run: 
streetNameLocator("marshall street", zoom = 0.5)
addNeighborhoodWalking()

## End(Not run)

[Package cholera version 0.7.5 Index]