diff --git a/R/client.R b/R/client.R index 11f43c5..c66006c 100644 --- a/R/client.R +++ b/R/client.R @@ -1,6 +1,6 @@ -#' Initialise an EMODnet WFS client +#' @description Initialise an EMODnet WFS client #' -#' Connect to a data source (service) +#' @title Connect to a data source (service) #' #' @param service the EMODnet OGC WFS service name. #' For available services, see [`emodnet_wfs()`]. diff --git a/R/emodnet_wfs.R b/R/emodnet_wfs.R index 69c2ba2..7c2f544 100644 --- a/R/emodnet_wfs.R +++ b/R/emodnet_wfs.R @@ -4,9 +4,9 @@ stringsAsFactors = FALSE ) } -#' Available EMODnet Web Feature Services +#' @description Available EMODnet Web Feature Services #' -#' Which data sources (services) are available? +#' @title Which data sources (services) are available? #' #' @return Tibble of available EMODnet Web Feature Services #' diff --git a/R/info.R b/R/info.R index 8ac0e12..e54abfb 100644 --- a/R/info.R +++ b/R/info.R @@ -76,9 +76,9 @@ emodnet_get_layer_info <- memoise::memoise(.emodnet_get_layer_info) layer_name = strsplit(layer_name, ":", fixed = TRUE)[[1]][2] ) } -#' Get WFS available layer information +#' @description Get WFS available layer information #' -#' Metadata about data available from the different services: +#' @title Metadata about data available from the different services: #' data (layers) from a data source (service), #' metadata on layers from a service, #' metadata on layers from all services. diff --git a/R/layer_attributes.R b/R/layer_attributes.R index 40af00a..aa72b5f 100644 --- a/R/layer_attributes.R +++ b/R/layer_attributes.R @@ -32,9 +32,9 @@ layer_attributes_summarise <- function(wfs = NULL, ) } -#' Get layer attribute description +#' @description Get layer attribute description #' -#' Variables available in a dataset (layer) from a data source (service). +#' @title Variables available in a dataset (layer) from a data source (service). #' #' @inheritParams emodnet_init_wfs_client #' @inheritParams emodnet_get_wfs_info @@ -97,9 +97,9 @@ layer_attributes_get_names <- function(wfs = NULL, )$name } -#' Inspect layer attributes +#' @description Inspect layer attributes #' -#' Summary of individual variable (attribute) in a dataset (layer) from a +#' @title Summary of individual variable (attribute) in a dataset (layer) from a #' data source (service). #' #' @inheritParams layer_attributes_summarise @@ -164,9 +164,9 @@ layer_attribute_inspect <- function(wfs = NULL, ) } -#' Get layer attribute values tibble +#' @description Get layer attribute values tibble #' -#' Possible values of variables (attributes) in a dataset (layer) +#' @title Possible values of variables (attributes) in a dataset (layer) #' from a data source (service). #' #' @inheritParams emodnet_init_wfs_client diff --git a/R/layers.R b/R/layers.R index 3adb5e4..bc4633f 100644 --- a/R/layers.R +++ b/R/layers.R @@ -1,4 +1,4 @@ -#' Get EMODnet WFS layers +#' Get EMODnet WFS datasets (layers) #' #' Performs an WFS getFeature request for layers from a `wfs` object or #' specified EMODnet Service. Filtering diff --git a/man/emodnet_get_layers.Rd b/man/emodnet_get_layers.Rd index 218cf82..0d6319c 100644 --- a/man/emodnet_get_layers.Rd +++ b/man/emodnet_get_layers.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/layers.R \name{emodnet_get_layers} \alias{emodnet_get_layers} -\title{Get EMODnet WFS layers} +\title{Get EMODnet WFS datasets (layers)} \usage{ emodnet_get_layers( wfs = NULL, diff --git a/man/emodnet_get_wfs_info.Rd b/man/emodnet_get_wfs_info.Rd index dee55f7..03d08cf 100644 --- a/man/emodnet_get_wfs_info.Rd +++ b/man/emodnet_get_wfs_info.Rd @@ -4,7 +4,10 @@ \alias{emodnet_get_layer_info} \alias{emodnet_get_wfs_info} \alias{emodnet_get_all_wfs_info} -\title{Get WFS available layer information} +\title{Metadata about data available from the different services: +data (layers) from a data source (service), +metadata on layers from a service, +metadata on layers from all services.} \usage{ emodnet_get_layer_info(wfs, layers) @@ -31,10 +34,7 @@ a tibble containing metadata on each layer available from the service. } \description{ -Metadata about data available from the different services: -data (layers) from a data source (service), -metadata on layers from a service, -metadata on layers from all services. +Get WFS available layer information } \details{ To minimize the number of requests sent to webservices, diff --git a/man/emodnet_init_wfs_client.Rd b/man/emodnet_init_wfs_client.Rd index 6413b2f..6e96241 100644 --- a/man/emodnet_init_wfs_client.Rd +++ b/man/emodnet_init_wfs_client.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/client.R \name{emodnet_init_wfs_client} \alias{emodnet_init_wfs_client} -\title{Initialise an EMODnet WFS client} +\title{Connect to a data source (service)} \usage{ emodnet_init_wfs_client(service, service_version = NULL, logger = NULL) } @@ -22,7 +22,7 @@ An \code{\link[ows4R:WFSClient]{ows4R::WFSClient}} R6 object with methods for in OGC Web Feature Service. } \description{ -Connect to a data source (service) +Initialise an EMODnet WFS client } \examples{ \dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/emodnet_wfs.Rd b/man/emodnet_wfs.Rd index cdfcbac..0f85e1f 100644 --- a/man/emodnet_wfs.Rd +++ b/man/emodnet_wfs.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/emodnet_wfs.R \name{emodnet_wfs} \alias{emodnet_wfs} -\title{Available EMODnet Web Feature Services} +\title{Which data sources (services) are available?} \usage{ emodnet_wfs() } @@ -10,7 +10,7 @@ emodnet_wfs() Tibble of available EMODnet Web Feature Services } \description{ -Which data sources (services) are available? +Available EMODnet Web Feature Services } \examples{ \dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/layer_attribute_descriptions.Rd b/man/layer_attribute_descriptions.Rd index 0ce6396..c7e032f 100644 --- a/man/layer_attribute_descriptions.Rd +++ b/man/layer_attribute_descriptions.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/layer_attributes.R \name{layer_attribute_descriptions} \alias{layer_attribute_descriptions} -\title{Get layer attribute description} +\title{Variables available in a dataset (layer) from a data source (service).} \usage{ layer_attribute_descriptions( wfs = NULL, @@ -28,7 +28,7 @@ the WFS service version. Now always "2.0.0".} data.frame containing layer attribute descriptions (metadata). } \description{ -Variables available in a dataset (layer) from a data source (service). +Get layer attribute description } \examples{ \dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/layer_attribute_inspect.Rd b/man/layer_attribute_inspect.Rd index eb6e7db..2e559c5 100644 --- a/man/layer_attribute_inspect.Rd +++ b/man/layer_attribute_inspect.Rd @@ -2,7 +2,8 @@ % Please edit documentation in R/layer_attributes.R \name{layer_attribute_inspect} \alias{layer_attribute_inspect} -\title{Inspect layer attributes} +\title{Summary of individual variable (attribute) in a dataset (layer) from a +data source (service).} \usage{ layer_attribute_inspect( wfs = NULL, @@ -34,8 +35,7 @@ useful for inspecting factor or character variable levels or unique values. } \description{ -Summary of individual variable (attribute) in a dataset (layer) from a -data source (service). +Inspect layer attributes } \examples{ \dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/layer_attributes_tbl.Rd b/man/layer_attributes_tbl.Rd index 600518a..3cd6952 100644 --- a/man/layer_attributes_tbl.Rd +++ b/man/layer_attributes_tbl.Rd @@ -2,7 +2,8 @@ % Please edit documentation in R/layer_attributes.R \name{layer_attributes_tbl} \alias{layer_attributes_tbl} -\title{Get layer attribute values tibble} +\title{Possible values of variables (attributes) in a dataset (layer) +from a data source (service).} \usage{ layer_attributes_tbl(wfs = NULL, service = NULL, service_version = NULL, layer) } @@ -24,8 +25,7 @@ tibble of layer attribute (variable) values with geometry column removed. } \description{ -Possible values of variables (attributes) in a dataset (layer) -from a data source (service). +Get layer attribute values tibble } \details{ Request excluding spatial information can be significantly faster. diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index cf979d8..a43564a 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -28,13 +28,13 @@ articles: - '`articles/request-params`' reference: -- title: Download information about web services +- title: Download information about data sources contents: - '`emodnet_wfs`' - '`emodnet_init_wfs_client`' - '`emodnet_get_wfs_info`' -- title: Download layers, or information about layers +- title: Download data or metadata contents: - '`emodnet_get_layers`' - '`layer_attribute_descriptions`'