addEuclideanPath {cholera} | R Documentation |
Add the path for the Euclidean distance between cases and/or pumps.
Description
Add the path for the Euclidean distance between cases and/or pumps.
Usage
addEuclideanPath(origin, destination = NULL, type = "case-pump",
observed = TRUE, case.location = "address", vestry = FALSE,
distance.unit = "meter", time.unit = "second", walking.speed = 5,
unit.posts = "distance", unit.interval = NULL, alpha.level = 1)
Arguments
origin |
Numeric or Integer. Numeric ID of case or pump. |
destination |
Numeric or Integer. Numeric ID(s) of case(s) or pump(s). Exclusion is possible via negative selection (e.g., -7). Default is |
type |
Character "case-pump", "cases" or "pumps". |
observed |
Logical. Use observed or simulated expected data. |
case.location |
Character. For |
vestry |
Logical. |
distance.unit |
Character. Unit of distance: "meter", "yard" or "native". "native" returns the map's native scale. See |
time.unit |
Character. "hour", "minute", or "second". |
walking.speed |
Numeric. Walking speed in km/hr. |
unit.posts |
Character. "distance" for mileposts; "time" for timeposts; |
unit.interval |
Numeric. Sets interval between |
alpha.level |
Numeric. Alpha level transparency for path: a value in [0, 1]. |
Value
An R list with 3 data frames: x-y coordinates for the origin and destination, and a summary of results.
Note
Walking time is computed using distanceTime()
.