diff --git a/R/layers.R b/R/layers.R index cc9ba76..fe21663 100644 --- a/R/layers.R +++ b/R/layers.R @@ -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). @@ -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 diff --git a/man/emodnet_get_layers.Rd b/man/emodnet_get_layers.Rd index 37b1cce..4012d30 100644 --- a/man/emodnet_get_layers.Rd +++ b/man/emodnet_get_layers.Rd @@ -48,7 +48,8 @@ Filters with names that do not correspond to any layers are ignored. Layers without corresponding filters are returned whole. }} -\item{reduce_layers}{whether to reduce output layers to a single \code{sf} object.} +\item{reduce_layers}{whether to reduce output layers to a single \code{sf} object. +This only works if the column names are the same.} \item{...}{additional vendor parameter arguments passed to \href{https://docs.geoserver.org/stable/en/user/services/wfs/reference.html#getfeature}{\code{ows4R::GetFeature()}}. @@ -60,7 +61,8 @@ bigger datasets.} If \code{reduce_layers = FALSE} (default), a list of \code{sf} objects, one element for each layer. Any layers for which download was unsuccessful will be NULL. If \code{reduce_layers = TRUE}, all layers are -reduced (if possible) to a single \code{sf} containing data for all layers. +reduced (if possible: if all +column names are the same) to a single \code{sf} containing data for all layers. \code{NULL} layers are ignored. \code{reduce_layers = TRUE} can also be used to return an \code{sf} out of a single layer request instead of a list of length 1. }