euclideanPath: Compute Euclidean path coordinates from observed...

View source: R/euclideanPath.R

euclideanPathR Documentation

Compute Euclidean path coordinates from observed case/landmark to nearest/selected pump.

Description

Compute Euclidean path coordinates from observed case/landmark to nearest/selected pump.

Usage

euclideanPath(origin = 1, destination = NULL, type = "case-pump",
  vestry = FALSE, latlong = FALSE, case.set = "observed",
  location = "nominal", weighted = TRUE, distance.unit = "meter",
  time.unit = "second", walking.speed = 5, include.landmarks = TRUE)

Arguments

origin

Numeric. Vector of origin(s) (numeric ID or character name landmark/pump ).

destination

Numeric. Vector of destination(s) (numeric or landmark/pump name).

type

Character. Path case to pump. FALSE is all other combinations of cases, landmarks and pumps.

vestry

Logical. TRUE uses the 14 pumps from the map in the Vestry Report. FALSE uses the 13 pumps from the original map.

latlong

Logical.

case.set

Character. "observed" or "expected".

location

Character. For cases and pumps. "nominal", "anchor" or "orthogonal".

weighted

Logical. TRUE computes shortest path in terms of road length. FALSE computes shortest path in terms of the number of nodes.

distance.unit

Character. Unit of distance: "meter" or "yard".

time.unit

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

walking.speed

Numeric. Walking speed in km/hr.

include.landmarks

Logical. Include landmarks as cases.


lindbrook/cholera documentation built on Jan. 13, 2025, 3:49 p.m.