From bb3dfb8196f6609659ed828de72321c1ce5ccce4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Mon, 12 Aug 2024 14:46:41 +0200 Subject: [PATCH] chore!: rename package Fix #163 --- DESCRIPTION | 8 +-- ...netWFS-package.R => emodnet.wfs-package.R} | 0 README.Rmd | 30 +++++------ README.md | 50 ++++++------------- EMODnetWFS.Rproj => emodnet.wfs.Rproj | 0 ...tWFS-package.Rd => emodnet.wfs-package.Rd} | 16 +++--- 6 files changed, 43 insertions(+), 61 deletions(-) rename R/{EMODnetWFS-package.R => emodnet.wfs-package.R} (100%) rename EMODnetWFS.Rproj => emodnet.wfs.Rproj (100%) rename man/{EMODnetWFS-package.Rd => emodnet.wfs-package.Rd} (72%) diff --git a/DESCRIPTION b/DESCRIPTION index c73228ce..2bf4dff9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,4 +1,4 @@ -Package: EMODnetWFS +Package: emodnet.wfs Title: Access EMODnet Web Feature Service data through R Version: 2.0.1.9001 Authors@R: c( @@ -15,9 +15,9 @@ Authors@R: c( Description: Access and interrogate EMODnet Web Feature Service data through R. License: MIT + file LICENSE -URL: https://emodnet.github.io/EMODnetWFS/, - https://github.com/EMODnet/EMODnetWFS -BugReports: https://github.com/EMODnet/EMODnetWFS/issues +URL: https://emodnet.github.io/emdonet.wfs/, + https://github.com/EMODnet/emdonet.wfs +BugReports: https://github.com/EMODnet/emdonet.wfs/issues Depends: R (>= 3.6.0) Imports: diff --git a/R/EMODnetWFS-package.R b/R/emodnet.wfs-package.R similarity index 100% rename from R/EMODnetWFS-package.R rename to R/emodnet.wfs-package.R diff --git a/README.Rmd b/README.Rmd index b65b381b..01501961 100644 --- a/README.Rmd +++ b/README.Rmd @@ -14,32 +14,32 @@ knitr::opts_chunk$set( options(timeout = 2000) ``` -# EMODnetWFS: Access EMODnet Web Feature Service data through R +# emodnet.wfs: Access EMODnet Web Feature Service data through R [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -[![R build status](https://github.com/EMODnet/EMODnetWFS/workflows/R-CMD-check/badge.svg)](https://github.com/EMODnet/EMODnetWFS/actions) -[![Codecov test coverage](https://codecov.io/gh/EMODnet/EMODnetWFS/branch/main/graph/badge.svg)](https://app.codecov.io/gh/EMODnet/EMODnetWFS/tree/main) +[![R build status](https://github.com/EMODnet/emodnet.wfs/workflows/R-CMD-check/badge.svg)](https://github.com/EMODnet/emodnet.wfs/actions) +[![Codecov test coverage](https://codecov.io/gh/EMODnet/emodnet.wfs/branch/main/graph/badge.svg)](https://app.codecov.io/gh/EMODnet/emodnet.wfs/tree/main) -The goal of EMODnetWFS is to allow interrogation of and access to [EMODnet geographic vector data](https://emodnet.ec.europa.eu/en/emodnet-web-service-documentation#inline-nav-3) in R though the [EMODnet Web Feature Services](https://emodnet.ec.europa.eu/en/data). +The goal of emodnet.wfs is to allow interrogation of and access to [EMODnet geographic vector data](https://emodnet.ec.europa.eu/en/emodnet-web-service-documentation#inline-nav-3) in R though the [EMODnet Web Feature Services](https://emodnet.ec.europa.eu/en/data). [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. +emodnet.wfs aims at offering an user-friendly interface to this rich data. ## Installation and setup -You can install the development version of EMODnetWFS from GitHub with: +You can install the development version of emodnet.wfs from GitHub with: ``` r # install.packages("pak") -pak::pak("EMODnet/EMODnetWFS") +pak::pak("EMODnet/emodnet.wfs") ``` -If you want to avoid reading messages from EMODnetWFS such as "WFS client created successfully", -set the `"EMODnetWFS.quiet"` option to `TRUE`. +If you want to avoid reading messages from emodnet.wfs such as "WFS client created successfully", +set the `"emodnet.wfs.quiet"` option to `TRUE`. ```r -options("EMODnetWFS.quiet" = TRUE) +options("emodnet.wfs.quiet" = TRUE) ``` ## Available services @@ -48,7 +48,7 @@ All available services are contained in the tibble returned by `emodnet_wfs()`. ```{r, echo=FALSE} -library(EMODnetWFS) +library(emodnet.wfs) knitr::kable(emodnet_wfs()) ``` @@ -151,7 +151,7 @@ emodnet_get_layers( If you get an unexpected error, - Look up the [EMODnet monitor](https://monitor.emodnet.eu/resources?lang=en&resource_type=OGC:WFS); -- Open an issue in this [repository](https://github.com/EMODnet/EMODnetWFS/issues). +- Open an issue in this [repository](https://github.com/EMODnet/emodnet.wfs/issues). ## Other web services @@ -182,14 +182,14 @@ head(year_2020_gridded_data$data) ### EMODnetWCS: Access EMODnet Web Coverage Service data -This package EMODnetWFS uses [Web Feature Services](https://www.ogc.org/standard/wfs/), hence it is limited to getting vector data. EMODnet also hosts raster data that can be accessed via [Web Coverage Services (WCS)](https://www.ogc.org/standard/wcs/). The R package [EMODnetWCS](https://github.com/EMODnet/EMODnetWCS) makes these data available in R. +This package emodnet.wfs uses [Web Feature Services](https://www.ogc.org/standard/wfs/), hence it is limited to getting vector data. EMODnet also hosts raster data that can be accessed via [Web Coverage Services (WCS)](https://www.ogc.org/standard/wcs/). The R package [EMODnetWCS](https://github.com/EMODnet/EMODnetWCS) makes these data available in R. ## Citation -To cite EMODnetWFS, please use the output from `citation(package = "EMODnetWFS")`. +To cite emodnet.wfs, please use the output from `citation(package = "emodnet.wfs")`. ```{r} -citation(package = "EMODnetWFS") +citation(package = "emodnet.wfs") ``` ## Acknowledgements diff --git a/README.md b/README.md index 12a2650c..c7712c0f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# EMODnetWFS: Access EMODnet Web Feature Service data through R +# emodnet.wfs: Access EMODnet Web Feature Service data through R @@ -9,12 +9,12 @@ state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![R build -status](https://github.com/EMODnet/EMODnetWFS/workflows/R-CMD-check/badge.svg)](https://github.com/EMODnet/EMODnetWFS/actions) +status](https://github.com/EMODnet/emodnet.wfs/workflows/R-CMD-check/badge.svg)](https://github.com/EMODnet/emodnet.wfs/actions) [![Codecov test -coverage](https://codecov.io/gh/EMODnet/EMODnetWFS/branch/main/graph/badge.svg)](https://app.codecov.io/gh/EMODnet/EMODnetWFS/tree/main) +coverage](https://codecov.io/gh/EMODnet/emodnet.wfs/branch/main/graph/badge.svg)](https://app.codecov.io/gh/EMODnet/emodnet.wfs/tree/main) -The goal of EMODnetWFS is to allow interrogation of and access to +The goal of emodnet.wfs is to allow interrogation of and access to [EMODnet geographic vector data](https://emodnet.ec.europa.eu/en/emodnet-web-service-documentation#inline-nav-3) in R though the [EMODnet Web Feature @@ -22,24 +22,24 @@ Services](https://emodnet.ec.europa.eu/en/data). [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 +at the feature and feature property level. emodnet.wfs aims at offering an user-friendly interface to this rich data. ## Installation and setup -You can install the development version of EMODnetWFS from GitHub with: +You can install the development version of emodnet.wfs from GitHub with: ``` r # install.packages("pak") -pak::pak("EMODnet/EMODnetWFS") +pak::pak("EMODnet/emodnet.wfs") ``` -If you want to avoid reading messages from EMODnetWFS such as “WFS -client created successfully”, set the `"EMODnetWFS.quiet"` option to +If you want to avoid reading messages from emodnet.wfs such as “WFS +client created successfully”, set the `"emodnet.wfs.quiet"` option to `TRUE`. ``` r -options("EMODnetWFS.quiet" = TRUE) +options("emodnet.wfs.quiet" = TRUE) ``` ## Available services @@ -84,9 +84,6 @@ wfs_bio <- emodnet_init_wfs_client(service = "biology") #> ✔ WFS client created successfully #> ℹ Service: "https://geo.vliz.be/geoserver/Emodnetbio/wfs" #> ℹ Version: "2.0.0" -``` - -``` r wfs_bio #> @@ -362,7 +359,7 @@ If you get an unexpected error, - Look up the [EMODnet monitor](https://monitor.emodnet.eu/resources?lang=en&resource_type=OGC:WFS); - Open an issue in this - [repository](https://github.com/EMODnet/EMODnetWFS/issues). + [repository](https://github.com/EMODnet/emodnet.wfs/issues). ## Other web services @@ -381,9 +378,6 @@ library(rerddap) #> Registered S3 method overwritten by 'hoardr': #> method from #> print.cache_info httr -``` - -``` r erddap_url <- "https://erddap.emodnet.eu/erddap/" @@ -401,9 +395,6 @@ rerddap::ed_datasets(url = erddap_url) #> 8 "" "/erd… /erddap… /erddap/tab… "" "/er… TAO/… "This … "/er… "/erddap… #> # ℹ 6 more variables: Info , Background.Info , RSS , #> # Email , Institution , Dataset.ID -``` - -``` r rerddap::ed_search(query = "vessel density", url = erddap_url) #> # A tibble: 16 × 2 @@ -425,9 +416,6 @@ rerddap::ed_search(query = "vessel density", url = erddap_url) #> 14 Vessel traffic density, 2019, Tanker EMODPACE_VD_10_Tan… #> 15 Vessel traffic density, 2019, Tug and Towing EMODPACE_VD_07_Tug #> 16 Vessel traffic density, 2019, Unknown EMODPACE_VD_12_Unk… -``` - -``` r human_activities_data_info <- rerddap::info(datasetid = "humanactivities_9f8a_3389_f08a", url = erddap_url) human_activities_data_info @@ -441,15 +429,9 @@ human_activities_data_info #> Variables: #> vd: #> Units: seconds -``` - -``` r year_2020_gridded_data <- griddap(datasetx = human_activities_data_info, time = c("2020-03-18", "2020-03-19")) #> info() output passed to x; setting base url to: https://erddap.emodnet.eu/erddap -``` - -``` r head(year_2020_gridded_data$data) #> x y time vd #> 1 -622500 7034500 2020-04-01T00:00:00Z NA @@ -462,7 +444,7 @@ head(year_2020_gridded_data$data) ### EMODnetWCS: Access EMODnet Web Coverage Service data -This package EMODnetWFS uses [Web Feature +This package emodnet.wfs uses [Web Feature Services](https://www.ogc.org/standard/wfs/), hence it is limited to getting vector data. EMODnet also hosts raster data that can be accessed via [Web Coverage Services (WCS)](https://www.ogc.org/standard/wcs/). @@ -471,12 +453,12 @@ these data available in R. ## Citation -To cite EMODnetWFS, please use the output from -`citation(package = "EMODnetWFS")`. +To cite emodnet.wfs, please use the output from +`citation(package = "emodnet.wfs")`. ``` r -citation(package = "EMODnetWFS") -#> To cite package 'EMODnetWFS' in publications use: +citation(package = "emodnet.wfs") +#> To cite package 'emodnet.wfs' in publications use: #> #> Krystalli A, Fernández-Bejarano S, Salmon M (????). _EMODnetWFS: #> Access EMODnet Web Feature Service data through R_. R package version diff --git a/EMODnetWFS.Rproj b/emodnet.wfs.Rproj similarity index 100% rename from EMODnetWFS.Rproj rename to emodnet.wfs.Rproj diff --git a/man/EMODnetWFS-package.Rd b/man/emodnet.wfs-package.Rd similarity index 72% rename from man/EMODnetWFS-package.Rd rename to man/emodnet.wfs-package.Rd index 85bc0021..3f1c9864 100644 --- a/man/EMODnetWFS-package.Rd +++ b/man/emodnet.wfs-package.Rd @@ -1,19 +1,19 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/EMODnetWFS-package.R +% Please edit documentation in R/emodnet.wfs-package.R \docType{package} -\name{EMODnetWFS-package} -\alias{EMODnetWFS} -\alias{EMODnetWFS-package} -\title{EMODnetWFS: Access EMODnet Web Feature Service data through R} +\name{emodnet.wfs-package} +\alias{emodnet.wfs} +\alias{emodnet.wfs-package} +\title{emodnet.wfs: Access EMODnet Web Feature Service data through R} \description{ Access and interrogate EMODnet Web Feature Service data through R. } \seealso{ Useful links: \itemize{ - \item \url{https://emodnet.github.io/EMODnetWFS/} - \item \url{https://github.com/EMODnet/EMODnetWFS} - \item Report bugs at \url{https://github.com/EMODnet/EMODnetWFS/issues} + \item \url{https://emodnet.github.io/emdonet.wfs/} + \item \url{https://github.com/EMODnet/emdonet.wfs} + \item Report bugs at \url{https://github.com/EMODnet/emdonet.wfs/issues} } }