cholera (version 0.9.1)

streetNameLocator: Locate street(s) by name(s).

Description

Highlight selected road(s) and cases.

Usage

streetNameLocator(street.name = "Broad Street", zoom = TRUE,
  latlong = FALSE, cases = "address", token = "id", vestry = FALSE,
  add.pump = TRUE, add.title = TRUE, add.subtitle = TRUE,
  highlight = TRUE, distance.unit = "meter", time.unit = "second",
  walking.speed = 5, cex.text = 0.67)

Value

A base R graphics plot.

Arguments

street.name

Character. A street name or vector of street names (e.g., "Broad Street", "Poland Street").

zoom

Logical or Numeric. Positive numbers zoom in; negative numbers zoom out.

latlong

Logical. Longitude and latitude coordinates

cases

Character. Cases to plot: NULL, "address" or "fatality".

token

Character. Cases as "id" or "point".

vestry

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

add.pump

Logical. Include pumps.

add.title

Logical. Include title.

add.subtitle

Logical. Include subtitle.

highlight

Logical. Highlight selected segment(s) and 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.

cex.text

Numeric.

Examples

if (FALSE) {
#' streetNameLocator("broad street")
streetNameLocator("Broad Street", zoom = -10)
streetNameLocator("Broad Street", latlong = TRUE, zoom = -10)
streetNameLocator("Broad Street", distance.unit = "yard")
streetNameLocator("Broad Street", zoom = FALSE)
}