diff --git a/R/used_here.R b/R/used_here.R index 292f8c9..5762785 100644 --- a/R/used_here.R +++ b/R/used_here.R @@ -2,19 +2,20 @@ #' #' @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 +#' Consistent with knitr syntax highlighting, [used_here()] adds a summary +#' table of R package & function usage to a knitted Quarto or R Markdown +#' document #' -#' @details If the rendered summary includes rows where the package name is multiple packages -#' separated by a comma, this will be due to an unresolved conflict. The recommended approach -#' is to use the 'conflicted' package. +#' @details If the rendered summary includes rows where the package name is +#' multiple packages separated by a comma, this will be due to an unresolved +#' conflict. The recommended approach is to use the 'conflicted' package. #' -#' @param fil If the usage summary is required in the document you are currently knitting, -#' then no argument need be specified. +#' @param fil If the usage summary is required in the document you are currently +#' knitting, then no argument need be specified. #' -#' If you want to create a summary by running just the code chunk, then it is necessary to -#' specify the quoted name of the saved file. You should first load and attach the packages -#' used in a fresh R session. +#' If you want to create a summary by running just the code chunk, then it is +#' necessary to specify the quoted name of the saved file. You should first +#' load and attach the packages used in a fresh R session. #' #' @return A printed kable table with the css class "usedthese" #' diff --git a/R/used_there.R b/R/used_there.R index 1e3b849..bcc3550 100644 --- a/R/used_there.R +++ b/R/used_there.R @@ -2,14 +2,14 @@ #' #' @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" +#' Harvests and consolidates function usage tables from pages of a Quarto +#' website by searching for tables with the CSS class "usedthese" #' -#' @param url The url to the website listing page of posts containing usage tables created with -#' [used_here()] +#' @param url The url to the website listing page of posts containing usage +#' tables created with [used_here()] #' -#' @param num_links The number of links returned from the listing page may be restricted using -#' this argument. +#' @param num_links The number of links returned from the listing page may be +#' restricted using this argument. #' #' @return A tibble summarising package & function usage #' diff --git a/man/used_here.Rd b/man/used_here.Rd index 50c9ff0..1fb9df0 100644 --- a/man/used_here.Rd +++ b/man/used_here.Rd @@ -15,12 +15,12 @@ used_here(fil = current_input()) } \arguments{ -\item{fil}{If the usage summary is required in the document you are currently knitting, -then no argument need be specified. +\item{fil}{If the usage summary is required in the document you are currently +knitting, then no argument need be specified. -If you want to create a summary by running just the code chunk, then it is necessary to -specify the quoted name of the saved file. You should first load and attach the packages -used in a fresh R session.} +If you want to create a summary by running just the code chunk, then it is +necessary to specify the quoted name of the saved file. You should first +load and attach the packages used in a fresh R session.} } \value{ A printed kable table with the css class "usedthese" @@ -28,13 +28,14 @@ A printed kable table with the css class "usedthese" \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -Consistent with knitr syntax highlighting, \code{\link[=used_here]{used_here()}} adds a -summary table of R package & function usage to a knitted Quarto or R Markdown document +Consistent with knitr syntax highlighting, \code{\link[=used_here]{used_here()}} adds a summary +table of R package & function usage to a knitted Quarto or R Markdown +document } \details{ -If the rendered summary includes rows where the package name is multiple packages -separated by a comma, this will be due to an unresolved conflict. The recommended approach -is to use the 'conflicted' package. +If the rendered summary includes rows where the package name is +multiple packages separated by a comma, this will be due to an unresolved +conflict. The recommended approach is to use the 'conflicted' package. } \examples{ # Simple example which mimics a two-line script and creates diff --git a/man/used_there.Rd b/man/used_there.Rd index faf5c2f..9879f7f 100644 --- a/man/used_there.Rd +++ b/man/used_there.Rd @@ -9,11 +9,11 @@ used_there(url, num_links = 30) } \arguments{ -\item{url}{The url to the website listing page of posts containing usage tables created with -\code{\link[=used_here]{used_here()}}} +\item{url}{The url to the website listing page of posts containing usage +tables created with \code{\link[=used_here]{used_here()}}} -\item{num_links}{The number of links returned from the listing page may be restricted using -this argument.} +\item{num_links}{The number of links returned from the listing page may be +restricted using this argument.} } \value{ A tibble summarising package & function usage @@ -21,8 +21,8 @@ A tibble summarising package & function usage \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -Harvests and consolidates function usage tables from pages of a Quarto website -by searching for tables with the CSS class "usedthese" +Harvests and consolidates function usage tables from pages of a Quarto +website by searching for tables with the CSS class "usedthese" } \examples{ # Uses a Quarto listing url to scrape & consolidate usage diff --git a/revdep/README.md b/revdep/README.md index 211e216..59a1a80 100644 --- a/revdep/README.md +++ b/revdep/README.md @@ -1,86 +1,30 @@ # Platform - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
field value
version R version 4.3.0 (2023-04-21)
os macOS Ventura 13.3.1
system aarch64, darwin20
ui RStudio
language (EN)
collate en_US.UTF-8
ctype en_US.UTF-8
tz Europe/London
date 2023-06-15
rstudio 2023.06.0+421 Mountain Hydrangea (desktop)
pandoc 3.1.1 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/ (via rmarkdown)
+|field |value | +|:--------|:---------------------------------------------------------------------------------------------------| +|version |R version 4.4.1 (2024-06-14) | +|os |macOS Sonoma 14.5 | +|system |aarch64, darwin20 | +|ui |RStudio | +|language |(EN) | +|collate |en_US.UTF-8 | +|ctype |en_US.UTF-8 | +|tz |Europe/London | +|date |2024-06-26 | +|rstudio |2024.04.2+764 Chocolate Cosmos (desktop) | +|pandoc |3.1.11 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/aarch64/ (via rmarkdown) | # Dependencies - - - - - - - - - - - - - - - - - - - - - - - -
package old new Δ
usedthese 0.3.2 0.3.2.9000 *
vctrs NA 0.6.2 *
+|package |old |new |Δ | +|:-----------|:-----|:----------|:--| +|usedthese |0.4.0 |0.4.0.9000 |* | +|cli |NA |3.6.3 |* | +|crayon |NA |1.5.3 |* | +|digest |NA |0.6.36 |* | +|evaluate |NA |0.24.0 |* | +|systemfonts |NA |1.1.0.9000 |* | +|xfun |NA |0.45 |* | # Revdeps