Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
lindbrook committed Mar 31, 2018
1 parent df4852c commit 8b46d01
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 5 deletions.
2 changes: 1 addition & 1 deletion R/addNeighborhood.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Add expected neighborhood polygons
#'
#' In-development prototype.
#' @param pump.subset Numeric. Vector of pumps to select (subset) from neighborhoods defined by "pump.select". Negative selection possible. NULL selectes all pumps in "pump.select".
#' @param pump.subset Numeric. Vector of pumps to select (subset) from neighborhoods defined by "pump.select". Negative selection possible. NULL selects all pumps in "pump.select".
#' @param pump.select Numeric. Numeric vector of pumps to define pump neighborhoods (i.e. the "population"). Negative selection possible. NULL selects all pumps.
#' @param vestry Logical. TRUE uses the 14 pumps from the Vestry Report. FALSE uses the 13 in the original map.
#' @param weighted Logical. TRUE computes shortest path weighted by road length. FALSE computes shortest path in terms of the number of nodes.
Expand Down
1 change: 0 additions & 1 deletion R/cholera.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
#' \item Appends actual street names to roads data.
#' \item Includes the revised pump data used in the second version of Snow's map from the Vestry report. This includes the "correct" location of the Broad Street pump.
#' \item Adds two different aggregate time series fatalities data sets, taken from the Vestry report.
#' }
#' \item Computes and visualizes two types of "pump neighborhoods": Voronoi (based on Euclidean distance) and walking (based on computed walking distances).
#' }
#' To learn more, start with the vignettes:
Expand Down
2 changes: 1 addition & 1 deletion R/nearestPump.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#' @param multi.core Logical or Numeric. TRUE uses parallel::detectCores(). FALSE uses one, single core. You can also specify the number logical cores. On Window, only "multi.core = FALSE" is available.
#' @param unit Character. Unit of measurement: "meter" or "yard". Default is NULL, which returns the map's native scale. Meaningful only when "weighted" is TRUE and "output" is "distance". See \code{vignette("roads")} for information on unit distances.
#' @export
#' @return An R data frome or list of 'igraph' paths.
#' @return An R data frame or list of 'igraph' paths.

nearestPump <- function(pump.select = NULL, output = "distance", vestry = FALSE,
weighted = TRUE, case.set = "observed", unit = NULL, multi.core = FALSE) {
Expand Down
2 changes: 1 addition & 1 deletion man/addNeighborhood.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions man/cholera-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/nearestPump.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8b46d01

Please sign in to comment.