updated most man files to give more informative one line for pkg leve…

…l index help
ropensci-archive · May 16, 2015 · 85a56c6 · 85a56c6
1 parent 23d680f
commit 85a56c6
Show file tree

Hide file tree

Showing 76 changed files with 95 additions and 85 deletions.
diff --git a/R/aggregate.R b/R/aggregate.R
@@ -1,4 +1,4 @@
-#' Aggregate
+#' Calculate a series of aggregations for a set of points within polygons
 #'
 #' Calculates a series of aggregations for a set of points within a set of
 #' polygons. Sum, average, count, min, max, deviation supported

diff --git a/R/along.R b/R/along.R
@@ -1,4 +1,4 @@
-#' Along
+#' Get a point at a distance along a line
 #'
 #' Takes a \code{\link{data-LineString}} and returns a \code{\link{data-Point}}
 #' at a specified distance along the line.

diff --git a/R/average.R b/R/average.R
@@ -1,4 +1,4 @@
-#' Average
+#' Average of a field among points within polygons
 #'
 #' Calculate the average value of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/R/bbox_polygon.R b/R/bbox_polygon.R
@@ -1,4 +1,4 @@
-#' Bbox polygon
+#' Make a polygon from a bounding box
 #'
 #' Takes a bbox and returns an equivalent polygon \code{\link{data-Polygon}}
 #'

diff --git a/R/bearing.R b/R/bearing.R
@@ -1,4 +1,4 @@
-#' Bearing
+#' Get geographic bearing between two points
 #'
 #' Takes two \code{\link{data-Point}}'s and finds the geographic bearing
 #' between them

diff --git a/R/bezier.R b/R/bezier.R
@@ -1,4 +1,4 @@
-#' Bezier
+#' Curve a linestring
 #'
 #' Takes a \code{\link{data-LineString}} and returns a curved version
 #' by applying a \href{http://en.wikipedia.org/wiki/Bezier_spline}{Bezier}

diff --git a/R/center.R b/R/center.R
@@ -1,4 +1,4 @@
-#' Center
+#' Get center point
 #'
 #' Takes a \code{\link{data-FeatureCollection}} and returns the
 #' absolute center point of all features

diff --git a/R/combine.R b/R/combine.R
@@ -1,4 +1,4 @@
-#' Combine
+#' Combine singular features into plural versions
 #'
 #' Combines a FeatureCollection of Point, LineString, or Polygon features into
 #' MultiPoint, MultiLineString, or MultiPolygon features.

diff --git a/R/concave.R b/R/concave.R
@@ -1,4 +1,4 @@
-#' Concave
+#' Concave hull polygon
 #'
 #' Takes a set of \code{\link{data-Point}}'s and returns a concave hull polygon.
 #' Internally, this implements a Monotone chain algorithm

diff --git a/R/convex.R b/R/convex.R
@@ -1,4 +1,4 @@
-#' Convex
+#' Convex hull polygon
 #'
 #' Takes a set of \code{\link{data-Point}}'s and returns a convex
 #' hull polygon. Internally, this uses the

diff --git a/R/count.R b/R/count.R
@@ -1,4 +1,4 @@
-#' Count points within polygons
+#' Count number of points within polygons
 #'
 #' Calculates the number of \code{\link{data-Point}}'s that fall within the set
 #' of \code{\link{data-Polygon}}'s

diff --git a/R/destination.R b/R/destination.R
@@ -1,4 +1,4 @@
-#' Destination
+#' Calculate destination point
 #'
 #' Takes a \code{\link{data-Point}} and calculates the location of a
 #' destination point given a distance in degrees, radians, miles, or kilometers; and

diff --git a/R/deviation.R b/R/deviation.R
@@ -1,4 +1,4 @@
-#' Deviation
+#' Standard deviation of a field among points within polygons
 #'
 #' Calculates the population standard deviation (i.e. denominator = n, not n-1) of
 #' values from \code{\link{data-Point}}'s within a set of \code{\link{data-Polygon}}'s

diff --git a/R/distance.R b/R/distance.R
@@ -1,4 +1,4 @@
-#' Distance
+#' Distance between two points
 #'
 #' Calculates the distance between two \code{\link{data-Point}}'s in degress,
 #' radians, miles, or kilometers. Uses the

diff --git a/R/envelope.R b/R/envelope.R
@@ -1,4 +1,4 @@
-#' Envelope
+#' Calculate envelope around features
 #'
 #' Takes any number of features and returns a rectangular
 #' \code{\link{data-Polygon}} that encompasses all vertices.

diff --git a/R/erase.R b/R/erase.R
@@ -1,4 +1,4 @@
-#' Erase
+#' Erase one polygon from another
 #'
 #' Finds the difference between two \code{\link{data-Polygon}}'s by clipping
 #' the second polygon from the first.

diff --git a/R/explode.R b/R/explode.R
@@ -1,4 +1,4 @@
-#' Explode
+#' Explode vertices to points
 #'
 #' Takes a feature or set of features and returns all positions as points
 #'

diff --git a/R/jenks.R b/R/jenks.R
@@ -1,4 +1,4 @@
-#' Jenks
+#' Get Jenks breaks
 #'
 #' Takes a set of \code{\link{data-Feature}}'s and returns an array of the Jenks
 #' Natural breaks for a given property

diff --git a/R/kinks.R b/R/kinks.R
@@ -1,6 +1,4 @@
-#' Kinks
-#'
-#' Takes a polygon and returns points at all self-intersections
+#' Get points at all self-intersections of a polygon
 #'
 #' @export
 #' @param input Feature of features

diff --git a/R/line_distance.R b/R/line_distance.R
@@ -1,4 +1,4 @@
-#' Line distance
+#' Measure a linestring
 #'
 #' Takes a \code{\link{data-LineString}} and measures its length in
 #' the specified units.

diff --git a/R/line_slice.R b/R/line_slice.R
@@ -1,4 +1,4 @@
-#' Line slice
+#' Slice a line given two points
 #'
 #' Takes a line, a start Point, and a stop point and returns the line in
 #' between those points

diff --git a/R/max.R b/R/max.R
@@ -1,4 +1,4 @@
-#' Maximum
+#' Maximum value of a field among points within polygons
 #'
 #' Calculates the maximum value of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/R/median.R b/R/median.R
@@ -1,4 +1,4 @@
-#' Median
+#' Median value of a field among points within polygons
 #'
 #' Calculates the variance value of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/R/merge.R b/R/merge.R
@@ -1,4 +1,4 @@
-#' Merge
+#' Merge polygons
 #'
 #' Takes a set of \code{\link{data-Polygon}}'s and returns a single
 #' merged polygon feature. If the input polygon features are not contiguous,
@@ -8,6 +8,7 @@
 #' @param fc input polygons, as \code{\link{data-FeatureCollection}}
 #' @template lint
 #' @family transformations
+#' @seealso \code{\link{lawn_union}}
 #' @return merged \code{\link{data-Polygon}} or multipolygon
 #' \code{\link{data-MultiPolygon}}
 #' @examples

diff --git a/R/midpoint.R b/R/midpoint.R
@@ -1,4 +1,4 @@
-#' Midpoint
+#' Get a point midway between two points
 #'
 #' Takes two \code{\link{data-Point}}'s and returns a point midway
 #' between them

diff --git a/R/min.R b/R/min.R
@@ -1,4 +1,4 @@
-#' Minimum
+#' Minimum value of a field among points within polygons
 #'
 #' Calculates the minimum value of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/R/nearest.R b/R/nearest.R
@@ -1,4 +1,4 @@
-#' Nearest
+#' Get nearest point
 #'
 #' Takes a reference \code{\link{data-Point}} and a set of points and returns the point from
 #' the set closest to the reference

diff --git a/R/point_on_line.R b/R/point_on_line.R
@@ -1,12 +1,13 @@
-#' Line slice
+#' Get closest point on linestring to reference point
 #'
-#' Takes a line, a start Point, and a stop point and returns the line in
-#' between those points
+#' Takes a line, a start \code{\link{data-Point}}, and a stop point and returns
+#' the line in between those points
 #'
 #' @export
 #' @param line line to snap to
 #' @param point point to snap from
 #' @template lint
+#' @return A \code{\link{data-Point}}
 #' @examples
 #' line <- '{
 #'   "type": "Feature",

diff --git a/R/point_on_surface.R b/R/point_on_surface.R
@@ -1,4 +1,4 @@
-#' Point on surface
+#' Get a point on the surface of a feature
 #'
 #' Finds a \code{\link{data-Point}} guaranteed to be on the surface of
 #' \code{\link{data-GeoJSON}} object.

diff --git a/R/quantile.R b/R/quantile.R
@@ -1,4 +1,4 @@
-#' Quantile
+#' Calculate quantiles
 #'
 #' Takes a \code{\link{data-FeatureCollection}}, a property name, set of percentiles
 #' and returns a quantile array

diff --git a/R/reclass.R b/R/reclass.R
@@ -1,4 +1,4 @@
-#' Reclass
+#' Reclassify properties data
 #'
 #' Takes a \code{\link{data-FeatureCollection}}, an input field, an output field,
 #' and an array of translations and outputs an identical FeatureCollection with

diff --git a/R/simplify.R b/R/simplify.R
@@ -1,4 +1,4 @@
-#' Simplify
+#' Simplify GeoJSON data
 #'
 #' Takes a \code{\link{data-LineString}} or \code{\link{data-Polygon}}
 #' and returns a simplified version

diff --git a/R/size.R b/R/size.R
@@ -1,4 +1,4 @@
-#' Size
+#' Expand a bounding box
 #'
 #' Takes a bounding box and returns a new bounding box with a size
 #' expanded or contracted by a factor of X.

diff --git a/R/square.R b/R/square.R
@@ -1,4 +1,4 @@
-#' Square
+#' Calculate a square bounding box
 #'
 #' Takes a bounding box and calculates the minimum square bounding
 #' box that would contain the input.

diff --git a/R/sum.R b/R/sum.R
@@ -1,4 +1,4 @@
-#' Sum
+#' Sum of a field among points within polygons
 #'
 #' Calculates the sum of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/R/tag.R b/R/tag.R
@@ -1,4 +1,4 @@
-#' Spatial join
+#' Spatial join of points and polygons
 #'
 #' Takes a set of \code{\link{data-Point}}'s and a set of
 #' \code{\link{data-Polygon}}'s and performs a spatial join

diff --git a/R/union.R b/R/union.R
@@ -1,6 +1,7 @@
-#' Union
+#' Merge polygons
 #'
-#' Finds the interesection of two polygons and returns the union of the two
+#' Finds the interesection of two \code{\link{data-Polygon}}'s and returns the
+#' union of the two
 #'
 #' @export
 #' @param poly1 A polygon
@@ -12,6 +13,7 @@
 #'
 #' @details Contiguous polygons are combined, non-contiguous polygons are returned
 #' as MultiPolygon
+#' @seealso \code{\link{lawn_merge}}
 #' @author Jeff Hollister \email{hollister.jeff@@epa.gov}
 #' @examples
 #' poly1 <- '{

diff --git a/R/variance.R b/R/variance.R
@@ -1,4 +1,4 @@
-#' Variance
+#' Variance of a field among points within polygons
 #'
 #' Calculates the variance value of a field for a set of \code{\link{data-Point}}'s
 #' within a set of \code{\link{data-Polygon}}'s

diff --git a/man/lawn_aggregate.Rd b/man/lawn_aggregate.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/aggregate.R
 \name{lawn_aggregate}
 \alias{lawn_aggregate}
-\title{Aggregate}
+\title{Calculate a series of aggregations for a set of points within polygons}
 \usage{
 lawn_aggregate(polys, pts, agg = list(c("count", "", "num_of_pts")),
   lint = FALSE)

diff --git a/man/lawn_along.Rd b/man/lawn_along.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/along.R
 \name{lawn_along}
 \alias{lawn_along}
-\title{Along}
+\title{Get a point at a distance along a line}
 \usage{
 lawn_along(line, distance, units, lint = FALSE)
 }

diff --git a/man/lawn_average.Rd b/man/lawn_average.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/average.R
 \name{lawn_average}
 \alias{lawn_average}
-\title{Average}
+\title{Average of a field among points within polygons}
 \usage{
 lawn_average(polygons, points, field, outputField = "average", lint = FALSE)
 }

diff --git a/man/lawn_bbox_polygon.Rd b/man/lawn_bbox_polygon.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/bbox_polygon.R
 \name{lawn_bbox_polygon}
 \alias{lawn_bbox_polygon}
-\title{Bbox polygon}
+\title{Make a polygon from a bounding box}
 \usage{
 lawn_bbox_polygon(bbox)
 }

diff --git a/man/lawn_bearing.Rd b/man/lawn_bearing.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/bearing.R
 \name{lawn_bearing}
 \alias{lawn_bearing}
-\title{Bearing}
+\title{Get geographic bearing between two points}
 \usage{
 lawn_bearing(start, end, lint = FALSE)
 }

diff --git a/man/lawn_bezier.Rd b/man/lawn_bezier.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/bezier.R
 \name{lawn_bezier}
 \alias{lawn_bezier}
-\title{Bezier}
+\title{Curve a linestring}
 \usage{
 lawn_bezier(line, resolution = 10000L, sharpness = 0.85, lint = FALSE)
 }

diff --git a/man/lawn_center.Rd b/man/lawn_center.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/center.R
 \name{lawn_center}
 \alias{lawn_center}
-\title{Center}
+\title{Get center point}
 \usage{
 lawn_center(features, lint = FALSE)
 }

diff --git a/man/lawn_combine.Rd b/man/lawn_combine.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/combine.R
 \name{lawn_combine}
 \alias{lawn_combine}
-\title{Combine}
+\title{Combine singular features into plural versions}
 \usage{
 lawn_combine(fc, lint = FALSE)
 }

diff --git a/man/lawn_concave.Rd b/man/lawn_concave.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/concave.R
 \name{lawn_concave}
 \alias{lawn_concave}
-\title{Concave}
+\title{Concave hull polygon}
 \usage{
 lawn_concave(points, maxEdge = 1, units = "miles", lint = FALSE)
 }

diff --git a/man/lawn_convex.Rd b/man/lawn_convex.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/convex.R
 \name{lawn_convex}
 \alias{lawn_convex}
-\title{Convex}
+\title{Convex hull polygon}
 \usage{
 lawn_convex(input, lint = FALSE)
 }

diff --git a/man/lawn_count.Rd b/man/lawn_count.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/count.R
 \name{lawn_count}
 \alias{lawn_count}
-\title{Count points within polygons}
+\title{Count number of points within polygons}
 \usage{
 lawn_count(polygons, points, countField = "pt_count", lint = FALSE)
 }

diff --git a/man/lawn_destination.Rd b/man/lawn_destination.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/destination.R
 \name{lawn_destination}
 \alias{lawn_destination}
-\title{Destination}
+\title{Calculate destination point}
 \usage{
 lawn_destination(start, distance, bearing, units, lint = FALSE)
 }

diff --git a/man/lawn_deviation.Rd b/man/lawn_deviation.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/deviation.R
 \name{lawn_deviation}
 \alias{lawn_deviation}
-\title{Deviation}
+\title{Standard deviation of a field among points within polygons}
 \usage{
 lawn_deviation(polys, pts, inField, outField, lint = FALSE)
 }

diff --git a/man/lawn_distance.Rd b/man/lawn_distance.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/distance.R
 \name{lawn_distance}
 \alias{lawn_distance}
-\title{Distance}
+\title{Distance between two points}
 \usage{
 lawn_distance(from, to, units = "kilometers", lint = FALSE)
 }

diff --git a/man/lawn_envelope.Rd b/man/lawn_envelope.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/envelope.R
 \name{lawn_envelope}
 \alias{lawn_envelope}
-\title{Envelope}
+\title{Calculate envelope around features}
 \usage{
 lawn_envelope(fc, lint = FALSE)
 }