addMilePosts {cholera}R Documentation

Add distance or time based "mileposts" to an observed walking neighborhood plot.

Description

Add distance or time based "mileposts" to an observed walking neighborhood plot.

Usage

addMilePosts(pump.subset = NULL, pump.select = NULL, vestry = FALSE,
  unit = "distance", interval = NULL, walking.speed = 5,
  type = "arrows", multi.core = TRUE, dev.mode = FALSE)

Arguments

pump.subset

Numeric. Vector of numeric pump IDs to subset from the neighborhoods defined by pump.select. Negative selection possible. NULL uses all pumps in pump.select.

pump.select

Numeric. Numeric vector of pumps to define possible pump neighborhoods (i.e. the "population"). Negative selection is possible. NULL selects all "observed" pumps (i.e., pumps with at least one case).

vestry

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

unit

Character. Milepost unit of measurement: "distance" or "time".

interval

Numeric. Interval between mileposts: 50 meters for "distance"; 60 seconds for "time".

walking.speed

Numeric. Walking speed in km/hr.

type

Character. "arrows" or "points".

multi.core

Logical or Numeric. TRUE uses parallel::detectCores(). FALSE uses one, single core. You can also specify the number logical cores. See vignette("Parallelization") for details.

dev.mode

Logical. Development mode uses parallel::parLapply().

Value

R base graphics arrows or points.


[Package cholera version 0.7.5 Index]