From e6b33a96dafd6378ca89bed7decbc16d1eeca12f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 5 Nov 2024 15:37:18 +0100 Subject: [PATCH] docs: description and safer example for `layer_attribute_descriptions()` --- R/layer_attributes.R | 6 +++--- man/layer_attribute_descriptions.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/layer_attributes.R b/R/layer_attributes.R index aed0302..5ef6365 100644 --- a/R/layer_attributes.R +++ b/R/layer_attributes.R @@ -35,6 +35,8 @@ 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 @@ -42,13 +44,11 @@ layer_attributes_summarise <- function(wfs = NULL, #' @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 index b3cc5bd..6bf30a2 100644 --- a/man/layer_attribute_descriptions.Rd +++ b/man/layer_attribute_descriptions.Rd @@ -28,13 +28,13 @@ the WFS service version. Now always "2.0.0".} data.frame containing layer attribute descriptions (metadata). } \description{ -Get layer attribute description +Variables available in a dataset (layer) from a data source (service). } \examples{ -\dontrun{ +\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} layer_attribute_descriptions( service = "biology", layer = "mediseh_zostera_m_pnt" ) -} +\dontshow{\}) # examplesIf} }