docs: description and safer example for layer_attribute_descriptions()

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

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/R/layer_attributes.R b/R/layer_attributes.R
@@ -35,20 +35,20 @@ layer_attributes_summarise <- function(wfs = NULL,
 
 #' Get layer attribute description
 #'
+#' Variables available in a dataset (layer) from a data source (service).
+#'
 #' @inheritParams emodnet_init_wfs_client
 #' @inheritParams emodnet_get_wfs_info
 #' @inheritParams layer_attributes_summarise
 #'
 #' @return data.frame containing layer attribute descriptions (metadata).
 #' @export
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf interactive()
 #' layer_attribute_descriptions(
 #'   service = "biology",
 #'   layer = "mediseh_zostera_m_pnt"
 #' )
-#' }
 layer_attribute_descriptions <- function(wfs = NULL,
                                          service = NULL,
                                          service_version = NULL, layer) {

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