nearestPump {cholera} | R Documentation |
Compute shortest distances or paths to selected pumps.
Description
Compute shortest distances or paths to selected pumps.
Usage
nearestPump(pump.select = NULL, metric = "walking", vestry = FALSE,
weighted = TRUE, case.set = "observed", distance.unit = "meter",
time.unit = "second", walking.speed = 5, multi.core = TRUE,
dev.mode = FALSE)
Arguments
pump.select |
Numeric. Pump candidates to consider. Default is |
metric |
Character. "euclidean" or "walking". |
vestry |
Logical. |
weighted |
Logical. |
case.set |
Character. "observed", "expected", or "snow". |
distance.unit |
Character. Unit of distance: "meter", "yard" or "native". "native" returns the map's native scale. Meaningful only when "weighted" is |
time.unit |
Character. "hour", "minute", or "second". |
walking.speed |
Numeric. Walking speed in km/hr. |
multi.core |
Logical or Numeric. |
dev.mode |
Logical. Development mode uses parallel::parLapply(). |
Value
An R data frame or list of 'igraph' path nodes.
Note
Time is computed using distanceTime()
.