Skip to content

Commit c6c02e0

Browse files
authored
Merge pull request #2266 from olivroy/doc
Use roxygen_md docs
2 parents fba7564 + e45ba2c commit c6c02e0

31 files changed

+114
-113
lines changed

DESCRIPTION

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ Description: Support for simple features, a standardized way to
5353
projection conversions and datum transformations. Uses by default the 's2'
5454
package for spherical geometry operations on ellipsoidal (long/lat) coordinates.
5555
License: GPL-2 | MIT + file LICENSE
56-
URL: https://r-spatial.github.io/sf/, https://github.com/r-spatial/sf/
57-
BugReports: https://github.com/r-spatial/sf/issues/
56+
URL: https://r-spatial.github.io/sf/, https://github.com/r-spatial/sf
57+
BugReports: https://github.com/r-spatial/sf/issues
5858
Depends:
5959
methods,
6060
R (>= 3.3.0)
@@ -114,7 +114,8 @@ VignetteBuilder:
114114
knitr
115115
Encoding: UTF-8
116116
RoxygenNote: 7.2.3
117-
Config/testhat/edition: 3
117+
Roxygen: list(markdown = TRUE)
118+
Config/testthat/edition: 2
118119
SystemRequirements: GDAL (>= 2.0.1), GEOS (>= 3.4.0),
119120
PROJ (>= 4.8.0), sqlite3
120121
Collate:

R/break_antimeridian.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#' on the chosen central longitude. The method may only be used with
77
#' non-projected, geographical coordinates and linestring or polygon objects.
88
#' s2 is turned off internally to permit the use of a rectangular bounding
9-
#' box. If the input geometries go outside [-180, 180] degrees longitude,
9+
#' box. If the input geometries go outside `[-180, 180]` degrees longitude,
1010
#' the protruding geometries will also be split using the same \code{tol=}
1111
#' values; in this case empty geometries will be dropped first.
1212
#'

R/geom-predicates.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ st_geos_binop = function(op, x, y, par = 0.0, pattern = NA_character_,
8181
#' @param y object of class \code{sf}, \code{sfc} or \code{sfg}
8282
#' @param pattern character; define the pattern to match to, see details.
8383
#' @param sparse logical; should a sparse matrix be returned (TRUE) or a dense matrix?
84-
#' @return In case \code{pattern} is not given, \code{st_relate} returns a dense \code{character} matrix; element [i,j] has nine characters, referring to the DE9-IM relationship between x[i] and y[j], encoded as IxIy,IxBy,IxEy,BxIy,BxBy,BxEy,ExIy,ExBy,ExEy where I refers to interior, B to boundary, and E to exterior, and e.g. BxIy the dimensionality of the intersection of the the boundary of x[i] and the interior of y[j], which is one of: 0, 1, 2, or F; digits denoting dimensionality of intersection, F denoting no intersection. When \code{pattern} is given, a dense logical matrix or sparse index list returned with matches to the given pattern; see \link{st_intersection} for a description of the returned matrix or list. See also \url{https://en.wikipedia.org/wiki/DE-9IM} for further explanation.
84+
#' @return In case \code{pattern} is not given, \code{st_relate} returns a dense \code{character} matrix; element `[i,j]` has nine characters, referring to the DE9-IM relationship between `x[i]` and `y[j]`, encoded as IxIy,IxBy,IxEy,BxIy,BxBy,BxEy,ExIy,ExBy,ExEy where I refers to interior, B to boundary, and E to exterior, and e.g. BxIy the dimensionality of the intersection of the the boundary of `x[i]` and the interior of `y[j]`, which is one of: 0, 1, 2, or F; digits denoting dimensionality of intersection, F denoting no intersection. When \code{pattern} is given, a dense logical matrix or sparse index list returned with matches to the given pattern; see \link{st_intersection} for a description of the returned matrix or list. See also \url{https://en.wikipedia.org/wiki/DE-9IM} for further explanation.
8585
#' @export
8686
#' @examples
8787
#' p1 = st_point(c(0,0))

R/geom-transformers.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -976,7 +976,7 @@ st_snap.sf = function(x, y, tolerance)
976976
#' @param y object of class \code{sf}, \code{sfc} or \code{sfg} (optional)
977977
#' @param ... ignored
978978
#' @seealso \link{st_intersection}, \link{st_difference}, \link{st_sym_difference}
979-
#' @return If \code{y} is missing, \code{st_union(x)} returns a single geometry with resolved boundaries, else the geometries for all unioned pairs of x[i] and y[j].
979+
#' @return If \code{y} is missing, \code{st_union(x)} returns a single geometry with resolved boundaries, else the geometries for all unioned pairs of `x[i]` and `y[j]`.
980980
#' @details
981981
#' If \code{st_union} is called with a single argument, \code{x}, (with \code{y} missing) and \code{by_feature} is \code{FALSE} all geometries are unioned together and an \code{sfg} or single-geometry \code{sfc} object is returned. If \code{by_feature} is \code{TRUE} each feature geometry is unioned individually. This can for instance be used to resolve internal boundaries after polygons were combined using \code{st_combine}. If \code{y} is provided, all elements of \code{x} and \code{y} are unioned, pairwise if \code{by_feature} is TRUE, or else as the Cartesian product of both sets.
982982
#'

R/plot.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -670,8 +670,8 @@ plot_sf = function(x, xlim = NULL, ylim = NULL, asp = NA, axes = FALSE, bgc = pa
670670

671671

672672
#' @param n integer; number of colors
673-
#' @param cutoff.tails numeric, in [0,0.5] start and end values
674-
#' @param alpha numeric, in [0,1], transparency
673+
#' @param cutoff.tails numeric, in `[0,0.5]` start and end values
674+
#' @param alpha numeric, in `[0,1]`, transparency
675675
#' @param categorical logical; do we want colors for a categorical variable? (see details)
676676
#' @name plot
677677
#' @export

man/Ops.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geos_binary_pred.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geos_combine.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geos_unary.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/plot.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/proj_tools.Rd

Lines changed: 15 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/sf_project.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/st_as_text.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/st_break_antimeridian.Rd

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/st_coordinates.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)