addNeighborhoodWalking: Add walking neighborhoods.

View source: R/addNeighborhoodWalking.R

addNeighborhoodWalkingR Documentation

Add walking neighborhoods.

Description

Add walking neighborhoods.

Usage

addNeighborhoodWalking(pump.select = NULL, vestry = FALSE,
  weighted = TRUE, case.set = "expected", latlong = FALSE,
  type = "area.polygons", tsp.method = "repetitive_nn", path.width = 2,
  alpha.level = 0.5, polygon.type = "solid", polygon.col = NULL,
  polygon.lwd = 2, multi.core = FALSE)

Arguments

pump.select

Numeric. Vector of numeric pump IDs to define pump neighborhoods (i.e., the "population"). Negative selection possible. NULL selects all pumps. Note that you can't just select the pump on Adam and Eve Court (#2) because it's technically an isolate.

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.

case.set

Character. "observed", "expected" or "snow". "snow" captures John Snow's annotation of the Broad Street pump neighborhood printed in the Vestry report version of the map.

latlong

Logical.

type

Character. "roads", "area.points" or "area.polygons". "area" flavors only valid when case.set = "expected".

tsp.method

Character. Traveling salesperson problem algorithm.

path.width

Numeric. Set width of paths.

alpha.level

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

polygon.type

Character. "border" 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.

Examples

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

## End(Not run)

lindbrook/cholera documentation built on March 5, 2025, 5:40 p.m.