addEuclideanPathB: Add Euclidean path from case/landmark to nearest or selected...

View source: R/addEuclideanPathB.R

addEuclideanPathBR Documentation

Add Euclidean path from case/landmark to nearest or selected pump. (prototype)

Description

Add Euclidean path from case/landmark to nearest or selected pump. (prototype)

Usage

addEuclideanPathB(origin = 1, destination = NULL, type = "case-pump",
  vestry = FALSE, latlong = FALSE, weighted = TRUE,
  distance.unit = "meter", time.unit = "second", walking.speed = 5,
  include.landmarks = TRUE, mileposts = TRUE, milepost.unit = "distance",
  milepost.interval = NULL, alpha.level = 1)

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.

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.

mileposts

Logical. Plot mile/time posts.

milepost.unit

Character. "distance" or "time".

milepost.interval

Numeric. Mile post interval unit of distance (yard or meter) or unit of time (seconds).

alpha.level

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


lindbrook/cholera documentation built on April 29, 2024, 12:22 p.m.