streetNameLocator: Locate road by name.

In cholera: Amend, Augment and Aid Analysis of John Snow's Cholera Map

Locate road by name.

Description

Highlight a road and its cases. See the list of road names in vignette("road.names").

Usage

streetNameLocator(road.name = "Broad Street", zoom = FALSE,
  cases = "address", token = "id", add.title = TRUE,
  add.subtitle = TRUE, add.pump = TRUE, vestry = FALSE,
  highlight = TRUE, distance.unit = "meter", time.unit = "minute",
  walking.speed = 5)

Arguments

road.name	Character vector. Note that streetNameLocator() tries to correct for case and to remove extra spaces.
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 distance: "meter", "yard" or "native". "native" returns the map's native scale. See vignette("roads") for information on conversion.
time.unit	Character. "hour", "minute", or "second".
walking.speed	Numeric. Walking speed in km/hr.

Value

A base R graphics plot.

Examples

streetNameLocator("Oxford Street")
streetNameLocator("oxford street")
streetNameLocator("Cambridge Street", zoom = TRUE)
streetNameLocator("Cambridge Street", zoom = 0.5)

cholera documentation built on March 7, 2023, 5:31 p.m.