Skip to content

Commit

Permalink
improve docs (for #99)
Browse files Browse the repository at this point in the history
  • Loading branch information
kadyb authored Feb 11, 2024
1 parent 48c4fcc commit df5b896
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Suggests:
terra
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
URL: https://kadyb.github.io/rgugik/, https://github.com/kadyb/rgugik
BugReports: https://github.com/kadyb/rgugik/issues
Roxygen: list(markdown = TRUE)
Expand Down
6 changes: 6 additions & 0 deletions R/DEM_request.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
#' (different formats of digital terrain model, digital surface model and
#' point clouds)
#'
#' @details
#' The server can return a maximum of 1000 records in a single query.
#' If your area of interest exceeds this limit, you can generate a grid of
#' smaller polygons ([`sf::st_make_grid()`]) or a regular grid of points
#' ([`sf::st_sample()`]).
#'
#' @seealso [`tile_download()`]
#'
#' @export
Expand Down
6 changes: 6 additions & 0 deletions R/ortho_request.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
#' @param x an `sf`, `sfc` or `SpatVector` object with one or more features
#' (requests are based on the bounding boxes of the provided features)
#'
#' @details
#' The server can return a maximum of 1000 records in a single query.
#' If your area of interest exceeds this limit, you can generate a grid of
#' smaller polygons ([`sf::st_make_grid()`]) or a regular grid of points
#' ([`sf::st_sample()`]).
#'
#' @return a data frame with metadata and links to the orthoimages
#'
#' @seealso [`tile_download()`]
Expand Down
6 changes: 6 additions & 0 deletions man/DEM_request.Rd

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

6 changes: 6 additions & 0 deletions man/ortho_request.Rd

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

0 comments on commit df5b896

Please sign in to comment.