docs: doc option that controls verbosity

EMODnet · Feb 28, 2024 · 26e47b5 · 26e47b5
1 parent 5a34446
commit 26e47b5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -26,7 +26,7 @@ The goal of EMODnetWFS is to allow interrogation of and access to [EMODnet geogr
 [Web Feature services (WFS)](https://www.ogc.org/standard/wfs/) represent a change in the way geographic information is created, modified and exchanged on the Internet and offer direct fine-grained access to geographic information at the feature and feature property level. 
 EMODnetWFS aims at offering an user-friendly interface to this rich data.
 
-## Installation
+## Installation and setup
 
 You can install the development version of EMODnetWFS from GitHub with:
 
@@ -35,6 +35,13 @@ You can install the development version of EMODnetWFS from GitHub with:
 pak::pak("EMODnet/EMODnetWFS")
 ```
 
+If you want to avoid reading messages from EMODnetWFS such as "WFS client created successfully", 
+set the `"EMODnetWFS.quiet"` option to `TRUE`.
+
+```r
+options("EMODnetWFS.quiet" = TRUE)
+```
+
 ## Available services
 
 All available services are contained in the tibble returned by `emodnet_wfs()`.

diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Internet and offer direct fine-grained access to geographic information
 at the feature and feature property level. EMODnetWFS aims at offering
 an user-friendly interface to this rich data.
 
-## Installation
+## Installation and setup
 
 You can install the development version of EMODnetWFS from GitHub with:
 
@@ -33,6 +33,14 @@ You can install the development version of EMODnetWFS from GitHub with:
 pak::pak("EMODnet/EMODnetWFS")
 ```
 
+If you want to avoid reading messages from EMODnetWFS such as “WFS
+client created successfully”, set the `"EMODnetWFS.quiet"` option to
+`TRUE`.
+
+``` r
+options("EMODnetWFS.quiet" = TRUE)
+```
+
 ## Available services
 
 All available services are contained in the tibble returned by