From a1d4f62e4c7468dafa4d536288aade249b7e93e9 Mon Sep 17 00:00:00 2001 From: Carl Goodwin Date: Fri, 14 Jun 2024 11:50:33 +0100 Subject: [PATCH] Add doi badge --- R/used_here.R | 2 ++ R/used_there.R | 2 ++ README.Rmd | 1 + README.md | 1 + docs/index.html | 1 + docs/pkgdown.yml | 2 +- docs/reference/used_here.html | 9 ++++++--- man/used_here.Rd | 2 ++ man/used_there.Rd | 2 ++ 9 files changed, 18 insertions(+), 4 deletions(-) diff --git a/R/used_here.R b/R/used_here.R index 852fc5f..9be3550 100644 --- a/R/used_here.R +++ b/R/used_here.R @@ -1,5 +1,7 @@ #' Summarise function usage in a single document #' +#' @description `r lifecycle::badge('experimental')` +#' #' Consistent with knitr syntax highlighting, [used_here()] adds a #' summary table of R package & function usage to a knitted Quarto or R Markdown document #' diff --git a/R/used_there.R b/R/used_there.R index f1410b5..1eb5c5b 100644 --- a/R/used_there.R +++ b/R/used_there.R @@ -1,5 +1,7 @@ #' Scrape the summaries for site-wide analysis #' +#' @description `r lifecycle::badge('experimental')` +#' #' Harvests and consolidates function usage tables from pages of a Quarto website #' by searching for tables with the CSS class "usedthese" #' diff --git a/README.Rmd b/README.Rmd index 9b349fc..6a7d778 100644 --- a/README.Rmd +++ b/README.Rmd @@ -21,6 +21,7 @@ knitr::opts_chunk$set( [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![Codecov test coverage](https://codecov.io/gh/cgoo4/usedthese/branch/main/graph/badge.svg)](https://app.codecov.io/gh/cgoo4/usedthese?branch=main) [![CRAN status](https://www.r-pkg.org/badges/version/usedthese)](https://CRAN.R-project.org/package=usedthese) +[![](https://img.shields.io/badge/doi-10.32614/CRAN.package.usedthese-skyblue.svg)](https://doi.org/10.32614/CRAN.package.usedthese) [![](https://cranlogs.r-pkg.org/badges/grand-total/usedthese?color=blue)](https://cran.r-project.org/package=usedthese) diff --git a/README.md b/README.md index 1f54258..f414f32 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h coverage](https://codecov.io/gh/cgoo4/usedthese/branch/main/graph/badge.svg)](https://app.codecov.io/gh/cgoo4/usedthese?branch=main) [![CRAN status](https://www.r-pkg.org/badges/version/usedthese)](https://CRAN.R-project.org/package=usedthese) +[![](https://img.shields.io/badge/doi-10.32614/CRAN.package.usedthese-skyblue.svg)](https://doi.org/10.32614/CRAN.package.usedthese) [![](https://cranlogs.r-pkg.org/badges/grand-total/usedthese?color=blue)](https://cran.r-project.org/package=usedthese) diff --git a/docs/index.html b/docs/index.html index d86b08b..cf78f65 100644 --- a/docs/index.html +++ b/docs/index.html @@ -161,6 +161,7 @@

Dev status

  • Lifecycle: experimental
  • Codecov test coverage
  • CRAN status
    • +
    • diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 4df7c1d..11236f4 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -4,7 +4,7 @@ pkgdown_sha: ~ articles: multipage: multipage.html usedthese: usedthese.html -last_built: 2024-06-05T09:02Z +last_built: 2024-06-14T10:48Z urls: reference: https://cgoo4.github.io/usedthese/reference article: https://cgoo4.github.io/usedthese/articles diff --git a/docs/reference/used_here.html b/docs/reference/used_here.html index b49e017..a2a1dbc 100644 --- a/docs/reference/used_here.html +++ b/docs/reference/used_here.html @@ -1,6 +1,8 @@ -Summarise function usage in a single document — used_here • usedtheseSummarise function usage in a single document — used_here • usedthese