neighborhoodEuclidean {cholera}R Documentation

Compute Euclidean path pump neighborhoods.

Description

Plots star graph from pump to its cases.

Usage

neighborhoodEuclidean(pump.select = NULL, vestry = FALSE,
  case.location = "nominal", case.set = "observed", multi.core = TRUE,
  dev.mode = FALSE)

Arguments

pump.select

Numeric. Vector of numeric pump IDs to define pump neighborhoods (i.e., the "population"). Negative selection possible. NULL selects all pumps.

vestry

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

case.location

Character. "address" or "nominal". For observed = TRUE: "address" uses ortho.proj and "nominal" uses fatalities. For observed = TRUE: "address" uses sim.ortho.proj and "nominal" uses regular.cases.

case.set

Character. "observed" or "expected".

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

An R vector.

Examples

## Not run: 
neighborhoodEuclidean()
neighborhoodEuclidean(-6)
neighborhoodEuclidean(pump.select = 6:7)

## End(Not run)

[Package cholera version 0.7.5 Index]