addWhitehead {cholera}R Documentation

Add Rev. Henry Whitehead's Broad Street pump neighborhood.

Description

A circle (polygon), centered around a desired pump with a radius of 210 yards. The Broad Street pump is the default.

Usage

addWhitehead(pump = "Broad Street", radius = 210, distance.unit = "yard",
  color = "black", line.type = "solid", vestry = FALSE,
  add.subtitle = FALSE, walking.speed = 5)

Arguments

pump

Character or Numeric. Name (road name) or numerical ID of selected pump. See pumps or pumps.vestry.

radius

Numeric. Distance from a pump.

distance.unit

Character. Unit of distance: "meter", "yard" or "native". "native" returns the map's native scale. See vignette("roads") for information on conversion.

color

Character. Color of circle.

line.type

Character. Circle line type.

vestry

Logical. TRUE uses the 14 pumps and locations from Vestry report. FALSE uses original 13 pumps.

add.subtitle

Logical. Add subtitle with estimated "walking" time in seconds.

walking.speed

Numeric. Walking speed in km/hr.

Value

Adds a circle (polygon) to a graphics plot.

Examples

snowMap(add.landmarks = FALSE)
addWhitehead()

[Package cholera version 0.7.5 Index]