Skip to content

Commit

Permalink
docs: explain reduce_layers more
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Nov 25, 2024
1 parent 60ba8dc commit 056ed55
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion R/layers.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#' Layers without corresponding filters are returned whole.
#'
#' @param reduce_layers whether to reduce output layers to a single `sf` object.
#' This only works if the column names are the same.
# nolint start: line_length_linter
#' @param ... additional vendor parameter arguments passed to
#' [`ows4R::GetFeature()`](https://docs.geoserver.org/stable/en/user/services/wfs/reference.html#getfeature).
Expand All @@ -36,7 +37,8 @@
#' @return If `reduce_layers = FALSE` (default), a list of `sf`
#' objects, one element for each layer. Any layers for which download was
#' unsuccessful will be NULL. If `reduce_layers = TRUE`, all layers are
#' reduced (if possible) to a single `sf` containing data for all layers.
#' reduced (if possible: if all
#' column names are the same) to a single `sf` containing data for all layers.
#' `NULL` layers are ignored. `reduce_layers = TRUE` can also be used to return
#' an `sf` out of a single layer request instead of a list of length 1.
#' @export
Expand Down
6 changes: 4 additions & 2 deletions man/emodnet_get_layers.Rd

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

0 comments on commit 056ed55

Please sign in to comment.