cholera (version 0.8.0)

latlongNearestPump: Compute shortest georeferenced distances (and walking paths) to selected pumps (prototype).

Description

Compute shortest georeferenced distances (and walking paths) to selected pumps (prototype).

Usage

latlongNearestPump(pump.select = NULL, metric = "walking",
  vestry = FALSE, weighted = TRUE, time.unit = "second",
  walking.speed = 5, multi.core = TRUE)

Value

An R data frame or list of 'igraph' path nodes.

Arguments

pump.select

Numeric. Pump candidates to consider. Default is NULL: all pumps are used. Otherwise, selection by a vector of numeric IDs: 1 to 13 for pumps; 1 to 14 for pumps.vestry. Negative selection allowed.

metric

Character. "euclidean" or "walking".

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 in terms of road length. FALSE computes shortest path in terms of the number of nodes.

time.unit

Character. "hour", "minute", or "second".

walking.speed

Numeric. Walking speed in km/hr.

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.