docs: Pkg now on cran, add doi and some other details. Fixes #1

ropensci · Sep 4, 2024 · 9cee97f · 9cee97f
1 parent a8988e6
commit 9cee97f
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ inst/doc
 README_cache
 vignettes/articles/mregions2-rdf_cache/*
 vignettes/mregions2_cache/*
+CRAN-SUBMISSION
diff --git a/README.Rmd b/README.Rmd
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 
-[![Funding](https://img.shields.io/static/v1?label=powered+by&message=lifewatch.be&labelColor=1a4e8a&color=f15922)](https://lifewatch.be) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/590_status.svg)](https://github.com/ropensci/software-review/issues/590) [![R-CMD-check](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/ropensci/mregions2/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/mregions2?branch=main)
+[![Funding](https://img.shields.io/static/v1?label=powered+by&message=lifewatch.be&labelColor=1a4e8a&color=f15922)](https://lifewatch.be) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/590_status.svg)](https://github.com/ropensci/software-review/issues/590) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mregions2)](https://cran.r-project.org/package=mregions2) [![R-CMD-check](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/ropensci/mregions2/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/mregions2?branch=main)
 
 <!-- badges: end -->
 
@@ -36,10 +36,10 @@ You can find detailed information in the articles online:
 
 ## Installation
 
-You can install mregions2 with:
+You can install the latest CRAN version with:
 
 ``` r
-install.packages("mregions2", repos = "https://ropensci.r-universe.dev")
+install.packages("mregions2")
 ```
 
 Or install the development version of mregions2 from GitHub with:
@@ -209,7 +209,7 @@ Objects_.
 
 ## Citation
 
-```{r citation, cache=FALSE}
+```{r citation, cache=FALSE, collapse=FALSE, comment="", results='asis'}
 citation("mregions2")
 ```
 

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 [![Funding](https://img.shields.io/static/v1?label=powered+by&message=lifewatch.be&labelColor=1a4e8a&color=f15922)](https://lifewatch.be)
 [![Status at rOpenSci Software Peer
 Review](https://badges.ropensci.org/590_status.svg)](https://github.com/ropensci/software-review/issues/590)
+[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mregions2)](https://cran.r-project.org/package=mregions2)
 [![R-CMD-check](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/mregions2/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/ropensci/mregions2/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/mregions2?branch=main)
@@ -38,10 +39,10 @@ You can find detailed information in the articles online:
 
 ## Installation
 
-You can install mregions2 with:
+You can install the latest CRAN version with:
 
 ``` r
-install.packages("mregions2", repos = "https://ropensci.r-universe.dev")
+install.packages("mregions2")
 ```
 
 Or install the development version of mregions2 from GitHub with:
@@ -367,22 +368,22 @@ boundaries data. Here is a non-exhaustive list:
 
 ``` r
 citation("mregions2")
-#> To cite package 'mregions2' in publications use:
-#> 
-#>   Fernandez-Bejarano S, Pohl L (2024). _mregions2: Access Data from
-#>   Marineregions.org: The Marine Regions Gazetteer and the Marine
-#>   Regions Data Products_. <https://github.com/ropensci/mregions2>.
-#> 
-#> A BibTeX entry for LaTeX users is
-#> 
-#>   @Manual{,
-#>     title = {{mregions2}: Access Data from Marineregions.org: The Marine Regions Gazetteer and the Marine Regions Data Products},
-#>     author = {Salvador Fernandez-Bejarano and Lotte Pohl},
-#>     year = {2024},
-#>     url = {https://github.com/ropensci/mregions2},
-#>   }
 ```
 
+To cite package ‘mregions2’ in publications use:
+
+Fernández Bejarano S, Pohl L (2024). *mregions2: Access Data from
+Marineregions.org: Gazetteer & Data Products*.
+<doi:10.32614/CRAN.package.mregions2>
+<https://doi.org/10.32614/CRAN.package.mregions2>.
+
+A BibTeX entry for LaTeX users is
+
+@Manual{, title = {mregions2: Access Data from Marineregions.org:
+Gazetteer & Data Products}, author = {Salvador Jesús {Fernández
+Bejarano} and Lotte Pohl}, year = {2024}, doi =
+{10.32614/CRAN.package.mregions2}, }
+
 ## License
 
 MIT. See `LICENSE.md`

diff --git a/inst/CITATION b/inst/CITATION
@@ -1,7 +1,7 @@
 year <- 2024
 
 bibentry(bibtype = "Manual",
-         title = "{mregions2}: Access Data from Marineregions.org: The Marine Regions Gazetteer and the Marine Regions Data Products",
-         author = c(person("Salvador", "Fernandez-Bejarano"), person("Lotte", "Pohl")),
+         title = "mregions2: Access Data from Marineregions.org: Gazetteer & Data Products",
+         author = c(person("Salvador Jesús", "Fernández Bejarano"), person("Lotte", "Pohl")),
          year = year,
-         url = "https://github.com/ropensci/mregions2")
+         doi = "10.32614/CRAN.package.mregions2")