From 85a56c638ea818bf5d7e8e777185b7eb770b022d Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Fri, 15 May 2015 18:11:03 -0700 Subject: [PATCH] updated most man files to give more informative one line for pkg level index help --- R/aggregate.R | 2 +- R/along.R | 2 +- R/average.R | 2 +- R/bbox_polygon.R | 2 +- R/bearing.R | 2 +- R/bezier.R | 2 +- R/center.R | 2 +- R/combine.R | 2 +- R/concave.R | 2 +- R/convex.R | 2 +- R/count.R | 2 +- R/destination.R | 2 +- R/deviation.R | 2 +- R/distance.R | 2 +- R/envelope.R | 2 +- R/erase.R | 2 +- R/explode.R | 2 +- R/jenks.R | 2 +- R/kinks.R | 4 +--- R/line_distance.R | 2 +- R/line_slice.R | 2 +- R/max.R | 2 +- R/median.R | 2 +- R/merge.R | 3 ++- R/midpoint.R | 2 +- R/min.R | 2 +- R/nearest.R | 2 +- R/point_on_line.R | 7 ++++--- R/point_on_surface.R | 2 +- R/quantile.R | 2 +- R/reclass.R | 2 +- R/simplify.R | 2 +- R/size.R | 2 +- R/square.R | 2 +- R/sum.R | 2 +- R/tag.R | 2 +- R/union.R | 6 ++++-- R/variance.R | 2 +- man/lawn_aggregate.Rd | 2 +- man/lawn_along.Rd | 2 +- man/lawn_average.Rd | 2 +- man/lawn_bbox_polygon.Rd | 2 +- man/lawn_bearing.Rd | 2 +- man/lawn_bezier.Rd | 2 +- man/lawn_center.Rd | 2 +- man/lawn_combine.Rd | 2 +- man/lawn_concave.Rd | 2 +- man/lawn_convex.Rd | 2 +- man/lawn_count.Rd | 2 +- man/lawn_destination.Rd | 2 +- man/lawn_deviation.Rd | 2 +- man/lawn_distance.Rd | 2 +- man/lawn_envelope.Rd | 2 +- man/lawn_erase.Rd | 2 +- man/lawn_explode.Rd | 2 +- man/lawn_jenks.Rd | 2 +- man/lawn_kinks.Rd | 4 ++-- man/lawn_line_distance.Rd | 2 +- man/lawn_line_slice.Rd | 2 +- man/lawn_max.Rd | 2 +- man/lawn_median.Rd | 2 +- man/lawn_merge.Rd | 4 +++- man/lawn_midpoint.Rd | 2 +- man/lawn_min.Rd | 2 +- man/lawn_nearest.Rd | 2 +- man/lawn_point_on_line.Rd | 9 ++++++--- man/lawn_point_on_surface.Rd | 2 +- man/lawn_quantile.Rd | 2 +- man/lawn_reclass.Rd | 2 +- man/lawn_simplify.Rd | 2 +- man/lawn_size.Rd | 2 +- man/lawn_square.Rd | 2 +- man/lawn_sum.Rd | 2 +- man/lawn_tag.Rd | 2 +- man/lawn_union.Rd | 7 +++++-- man/lawn_variance.Rd | 2 +- 76 files changed, 95 insertions(+), 85 deletions(-) diff --git a/R/aggregate.R b/R/aggregate.R index d7a0ab7..e28d4d7 100644 --- 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 index 3195499..5053a5b 100644 --- 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 index 80e3a05..a277b9d 100644 --- 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 index 4adc4c2..b01d3ce 100644 --- 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 index a486e6d..28e2805 100644 --- 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 index ba057a1..b1f5114 100644 --- 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 index d81274f..8847065 100644 --- 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 index 7a2157e..cabd55b 100644 --- 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 index 90d53b7..ed41e6c 100644 --- 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 index bb6beff..9583965 100644 --- 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 index e5e667a..55475ca 100644 --- 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 index 02b1209..639bd57 100644 --- 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 index 2999e10..2635727 100644 --- 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 index 8753bc3..6cacff2 100644 --- 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 index d719a59..67fd8c7 100644 --- 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 index 51e73b3..ee45f43 100644 --- 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 index 7f628ba..3c646eb 100644 --- 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 index 61ae8d3..0cdc5f2 100644 --- 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 index 7fb480d..f714cbb 100644 --- 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 index 5537a6d..e94631d 100644 --- 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 index 9acf47d..5767717 100644 --- 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 index 66cd1df..7155e5d 100644 --- 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 index c0fa6f6..bd6e820 100644 --- 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 index 39e2e72..1dcc85f 100644 --- 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 index c11b522..48283e1 100644 --- 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 index 8757149..5eb3905 100644 --- 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 index 8e1280d..19524b1 100644 --- 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 index 6f85959..e4770b0 100644 --- 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 index 1f13b9c..9aaf667 100644 --- 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 index e605d19..a85de1f 100644 --- 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 index c429093..c9ddcd8 100644 --- 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 index f6bf35d..b2d2c69 100644 --- 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 index 18b0ebc..7d6d5ec 100644 --- 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 index ec04057..18f0d02 100644 --- 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 index 0ee9e04..0cc25c3 100644 --- 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 index 015946b..3a0cdb0 100644 --- 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 index da8dc10..facf40e 100644 --- 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 index bb2446f..9ca2e8b 100644 --- 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 index 25e46c4..0455de8 100644 --- 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 index 400986f..f90326d 100644 --- 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 index 487dc28..7f8edf4 100644 --- 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 index 230381e..76deaa5 100644 --- 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 index b47e5f3..b36a4f7 100644 --- 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 index cac6a18..36c12b1 100644 --- 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 index 421baec..86f5189 100644 --- 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 index aaf82c4..5970d66 100644 --- 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 index 2339807..f1039a1 100644 --- 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 index 583379b..b5c8ba9 100644 --- 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 index 5ae83f4..8d82cc8 100644 --- 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 index 811252c..625562b 100644 --- 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 index 73fa1ed..3fc8cf9 100644 --- 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 index c9a4401..6077dae 100644 --- 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 index d7348b3..8e66e6b 100644 --- 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) } diff --git a/man/lawn_erase.Rd b/man/lawn_erase.Rd index 79e3a3b..bf08a3b 100644 --- a/man/lawn_erase.Rd +++ b/man/lawn_erase.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/erase.R \name{lawn_erase} \alias{lawn_erase} -\title{Erase} +\title{Erase one polygon from another} \usage{ lawn_erase(poly1, poly2, lint = FALSE) } diff --git a/man/lawn_explode.Rd b/man/lawn_explode.Rd index 371ea23..d98dd35 100644 --- a/man/lawn_explode.Rd +++ b/man/lawn_explode.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/explode.R \name{lawn_explode} \alias{lawn_explode} -\title{Explode} +\title{Explode vertices to points} \usage{ lawn_explode(input, lint = FALSE) } diff --git a/man/lawn_jenks.Rd b/man/lawn_jenks.Rd index bfb9ed4..5066f5b 100644 --- a/man/lawn_jenks.Rd +++ b/man/lawn_jenks.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/jenks.R \name{lawn_jenks} \alias{lawn_jenks} -\title{Jenks} +\title{Get Jenks breaks} \usage{ lawn_jenks(input, field, numberOfBreaks, lint = FALSE) } diff --git a/man/lawn_kinks.Rd b/man/lawn_kinks.Rd index 8a69c8c..a2d2e01 100644 --- a/man/lawn_kinks.Rd +++ b/man/lawn_kinks.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/kinks.R \name{lawn_kinks} \alias{lawn_kinks} -\title{Kinks} +\title{Get points at all self-intersections of a polygon} \usage{ lawn_kinks(input, lint = FALSE) } @@ -15,7 +15,7 @@ default for small objects, but not for large if you know they are good geojson objects. Default: \code{FALSE}} } \description{ -Takes a polygon and returns points at all self-intersections +Get points at all self-intersections of a polygon } \examples{ poly <- '{ diff --git a/man/lawn_line_distance.Rd b/man/lawn_line_distance.Rd index e516d74..ad5e224 100644 --- a/man/lawn_line_distance.Rd +++ b/man/lawn_line_distance.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/line_distance.R \name{lawn_line_distance} \alias{lawn_line_distance} -\title{Line distance} +\title{Measure a linestring} \usage{ lawn_line_distance(line, units, lint = FALSE) } diff --git a/man/lawn_line_slice.Rd b/man/lawn_line_slice.Rd index 178961b..7fcb0a3 100644 --- a/man/lawn_line_slice.Rd +++ b/man/lawn_line_slice.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/line_slice.R \name{lawn_line_slice} \alias{lawn_line_slice} -\title{Line slice} +\title{Slice a line given two points} \usage{ lawn_line_slice(point1, point2, line, lint = FALSE) } diff --git a/man/lawn_max.Rd b/man/lawn_max.Rd index e65215a..3cc9e50 100644 --- a/man/lawn_max.Rd +++ b/man/lawn_max.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/max.R \name{lawn_max} \alias{lawn_max} -\title{Maximum} +\title{Maximum value of a field among points within polygons} \usage{ lawn_max(polygons, points, in_field, out_field, lint = FALSE) } diff --git a/man/lawn_median.Rd b/man/lawn_median.Rd index 7fe1627..31b0556 100644 --- a/man/lawn_median.Rd +++ b/man/lawn_median.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/median.R \name{lawn_median} \alias{lawn_median} -\title{Median} +\title{Median value of a field among points within polygons} \usage{ lawn_median(polygons, points, in_field, out_field, lint = FALSE) } diff --git a/man/lawn_merge.Rd b/man/lawn_merge.Rd index d74b219..ef5679c 100644 --- a/man/lawn_merge.Rd +++ b/man/lawn_merge.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/merge.R \name{lawn_merge} \alias{lawn_merge} -\title{Merge} +\title{Merge polygons} \usage{ lawn_merge(fc, lint = FALSE) } @@ -61,6 +61,8 @@ polygons <- '{ lawn_merge(polygons) } \seealso{ +\code{\link{lawn_union}} + Other transformations: \code{\link{lawn_bezier}}; \code{\link{lawn_buffer}}; \code{\link{lawn_concave}}; \code{\link{lawn_convex}}; \code{\link{lawn_erase}}; diff --git a/man/lawn_midpoint.Rd b/man/lawn_midpoint.Rd index 6f3599a..b4c3859 100644 --- a/man/lawn_midpoint.Rd +++ b/man/lawn_midpoint.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/midpoint.R \name{lawn_midpoint} \alias{lawn_midpoint} -\title{Midpoint} +\title{Get a point midway between two points} \usage{ lawn_midpoint(pt1, pt2, lint = FALSE) } diff --git a/man/lawn_min.Rd b/man/lawn_min.Rd index af3f12d..bbdfb16 100644 --- a/man/lawn_min.Rd +++ b/man/lawn_min.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/min.R \name{lawn_min} \alias{lawn_min} -\title{Minimum} +\title{Minimum value of a field among points within polygons} \usage{ lawn_min(polygons, points, in_field, out_field, lint = FALSE) } diff --git a/man/lawn_nearest.Rd b/man/lawn_nearest.Rd index 7f5e587..ef31795 100644 --- a/man/lawn_nearest.Rd +++ b/man/lawn_nearest.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/nearest.R \name{lawn_nearest} \alias{lawn_nearest} -\title{Nearest} +\title{Get nearest point} \usage{ lawn_nearest(point, against, lint = FALSE) } diff --git a/man/lawn_point_on_line.Rd b/man/lawn_point_on_line.Rd index b56dc92..4b902c2 100644 --- a/man/lawn_point_on_line.Rd +++ b/man/lawn_point_on_line.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/point_on_line.R \name{lawn_point_on_line} \alias{lawn_point_on_line} -\title{Line slice} +\title{Get closest point on linestring to reference point} \usage{ lawn_point_on_line(line, point, lint = FALSE) } @@ -16,9 +16,12 @@ as the object to get linted increases in size, so probably use by default for small objects, but not for large if you know they are good geojson objects. Default: \code{FALSE}} } +\value{ +A \code{\link{data-Point}} +} \description{ -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 } \examples{ line <- '{ diff --git a/man/lawn_point_on_surface.Rd b/man/lawn_point_on_surface.Rd index 345ed24..4196d9d 100644 --- a/man/lawn_point_on_surface.Rd +++ b/man/lawn_point_on_surface.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/point_on_surface.R \name{lawn_point_on_surface} \alias{lawn_point_on_surface} -\title{Point on surface} +\title{Get a point on the surface of a feature} \usage{ lawn_point_on_surface(x, lint = FALSE) } diff --git a/man/lawn_quantile.Rd b/man/lawn_quantile.Rd index 96e5168..cdf5171 100644 --- a/man/lawn_quantile.Rd +++ b/man/lawn_quantile.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/quantile.R \name{lawn_quantile} \alias{lawn_quantile} -\title{Quantile} +\title{Calculate quantiles} \usage{ lawn_quantile(input, field, percentiles, lint = FALSE) } diff --git a/man/lawn_reclass.Rd b/man/lawn_reclass.Rd index 6fc1a7f..5998b32 100644 --- a/man/lawn_reclass.Rd +++ b/man/lawn_reclass.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/reclass.R \name{lawn_reclass} \alias{lawn_reclass} -\title{Reclass} +\title{Reclassify properties data} \usage{ lawn_reclass(input, inField, outField, translations, lint = FALSE) } diff --git a/man/lawn_simplify.Rd b/man/lawn_simplify.Rd index d6f12fe..4c4c85a 100644 --- a/man/lawn_simplify.Rd +++ b/man/lawn_simplify.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/simplify.R \name{lawn_simplify} \alias{lawn_simplify} -\title{Simplify} +\title{Simplify GeoJSON data} \usage{ lawn_simplify(feature, tolerance = 0.01, high_quality = FALSE, lint = FALSE) diff --git a/man/lawn_size.Rd b/man/lawn_size.Rd index 4f72bc0..e7d1097 100644 --- a/man/lawn_size.Rd +++ b/man/lawn_size.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/size.R \name{lawn_size} \alias{lawn_size} -\title{Size} +\title{Expand a bounding box} \usage{ lawn_size(bbox, factor) } diff --git a/man/lawn_square.Rd b/man/lawn_square.Rd index 119a4e9..cfa0eaf 100644 --- a/man/lawn_square.Rd +++ b/man/lawn_square.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/square.R \name{lawn_square} \alias{lawn_square} -\title{Square} +\title{Calculate a square bounding box} \usage{ lawn_square(bbox) } diff --git a/man/lawn_sum.Rd b/man/lawn_sum.Rd index 29ac85a..10f88e3 100644 --- a/man/lawn_sum.Rd +++ b/man/lawn_sum.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/sum.R \name{lawn_sum} \alias{lawn_sum} -\title{Sum} +\title{Sum of a field among points within polygons} \usage{ lawn_sum(polygons, points, in_field, out_field, lint = FALSE) } diff --git a/man/lawn_tag.Rd b/man/lawn_tag.Rd index e90edac..59173cc 100644 --- a/man/lawn_tag.Rd +++ b/man/lawn_tag.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/tag.R \name{lawn_tag} \alias{lawn_tag} -\title{Spatial join} +\title{Spatial join of points and polygons} \usage{ lawn_tag(points, polygons, poly_id, containing_polyid, lint = FALSE) } diff --git a/man/lawn_union.Rd b/man/lawn_union.Rd index 0a4be4a..5af442f 100644 --- a/man/lawn_union.Rd +++ b/man/lawn_union.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/union.R \name{lawn_union} \alias{lawn_union} -\title{Union} +\title{Merge polygons} \usage{ lawn_union(poly1, poly2, lint = FALSE) } @@ -21,7 +21,8 @@ a combined \code{\link{data-Polygon}} or \code{\link{data-MultiPolygon}} feature } \description{ -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 } \details{ Contiguous polygons are combined, non-contiguous polygons are returned @@ -70,6 +71,8 @@ lawn_union(poly1, poly2) Jeff Hollister \email{hollister.jeff@epa.gov} } \seealso{ +\code{\link{lawn_merge}} + Other transformations: \code{\link{lawn_bezier}}; \code{\link{lawn_buffer}}; \code{\link{lawn_concave}}; \code{\link{lawn_convex}}; \code{\link{lawn_erase}}; diff --git a/man/lawn_variance.Rd b/man/lawn_variance.Rd index 023362e..541368f 100644 --- a/man/lawn_variance.Rd +++ b/man/lawn_variance.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/variance.R \name{lawn_variance} \alias{lawn_variance} -\title{Variance} +\title{Variance of a field among points within polygons} \usage{ lawn_variance(polygons, points, in_field, out_field, lint = FALSE) }