streetNumberLocator {cholera}R Documentation

Locate road by numerical ID.

Description

Highlight a road and its cases. See cholera::roads for numerical IDs and vignette("road.names") for details.

Usage

streetNumberLocator(road.number = 216, zoom = FALSE, cases = "address",
  token = "id", add.title = TRUE, add.subtitle = TRUE, add.pump = TRUE,
  vestry = FALSE, highlight = TRUE, distance.unit = "meter",
  time.unit = "second", walking.speed = 5)

Arguments

road.number

Numeric or integer. A whole number between 1 and 528.

zoom

Logical or Numeric. A numeric value >= 0 controls the degree of zoom. The default is FALSE, which is equivalent to zero.

cases

Character. Plot cases: NULL, "address" or "fatality".

token

Character. "id" or "point".

add.title

Logical. Include title.

add.subtitle

Logical. Include subtitle with road information.

add.pump

Logical. Include nearby pumps.

vestry

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

highlight

Logical. Highlight selected road and its cases.

distance.unit

Character. Unit of measurement: "meter" or "yard". Default is NULL, which returns the map's native scale.

time.unit

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

walking.speed

Numeric. Walking speed in km/hr.

Value

A base R graphics plot.

Examples

streetNumberLocator(243)
streetNumberLocator(243, zoom = TRUE)
streetNumberLocator(243, zoom = 0.5)

[Package cholera version 0.7.5 Index]