pumpData {cholera}R Documentation

Compute pump coordinates.

Description

Returns either the set of x-y coordinates for the pumps themselves or for their orthogonally projected "addresses" on the network of roads.

Usage

pumpData(vestry = FALSE, orthogonal = FALSE, multi.core = TRUE)

Arguments

vestry

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

orthogonal

Logical. TRUE returns pump "addresses": the coordinates of the orthogonal projection from a pump's location onto the network of roads. FALSE returns pump location coordinates.

multi.core

Logical or Numeric. TRUE uses parallel::detectCores(). FALSE uses one, single core. With Numeric, you specify the number logical cores (rounds with as.integer()). See vignette("Parallelization") for details.

Value

An R data frame.

Note

Note: The location of the fourteenth pump, at Hanover Square, and the "correct" location of the Broad Street pump are approximate. This function documents the code that generates pumps, pumps.vestry, ortho.proj.pump and ortho.proj.pump.vestry.

See Also

pumpLocator


[Package cholera version 0.7.5 Index]