docs: for a better pkgdown ref index

EMODnet · Nov 7, 2024 · 02f7e66 · 02f7e66
1 parent 41fba4d
commit 02f7e66
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 33 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/man/emodnet_get_wfs_info.Rd b/man/emodnet_get_wfs_info.Rd
diff --git a/man/emodnet_init_wfs_client.Rd b/man/emodnet_init_wfs_client.Rd
diff --git a/man/emodnet_wfs.Rd b/man/emodnet_wfs.Rd
diff --git a/man/layer_attribute_descriptions.Rd b/man/layer_attribute_descriptions.Rd
diff --git a/man/layer_attribute_inspect.Rd b/man/layer_attribute_inspect.Rd
diff --git a/man/layer_attributes_tbl.Rd b/man/layer_attributes_tbl.Rd
diff --git 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`'