docs: description and safer example for layer_attribute_inspect()

EMODnet · Nov 5, 2024 · b4ccb64 · b4ccb64
1 parent e6b33a9
commit b4ccb64
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/R/layer_attributes.R b/R/layer_attributes.R
@@ -98,6 +98,9 @@ layer_attributes_get_names <- function(wfs = NULL,
 
 #' Inspect layer attributes
 #'
+#' Summary of individual variable (attribute) in a dataset (layer) from a
+#' data source (service).
+#'
 #' @inheritParams layer_attributes_summarise
 #' @param attribute character string, name of layer attribute (variable). Use
 #' [layer_attributes_get_names()] to get layer attribute names.
@@ -109,15 +112,13 @@ layer_attributes_get_names <- function(wfs = NULL,
 #' factor or character variable levels or unique values.
 #' @export
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf interactive()
 #' wfs <- emodnet_init_wfs_client(service = "biology")
 #' layer_attributes_get_names(wfs, layer = "mediseh_zostera_m_pnt")
 #' layer_attribute_inspect(
 #'   wfs, layer = "mediseh_zostera_m_pnt",
 #'   attribute = "country"
 #' )
-#' }
 layer_attribute_inspect <- function(wfs = NULL,
                                     service = NULL,
                                     service_version = NULL,

diff --git a/man/layer_attribute_inspect.Rd b/man/layer_attribute_inspect.Rd