Overview
usedthese is a pair of functions to summarise package & function usage in Quarto documents consistent with knitr’s syntax highlighting:
used_here()
adds a nicely-rendered summary table of usage to a single document;used_there()
harvests and consolidates the tables created above ready for site-wide analysis.
Example Use Case
Each “little project” on the Quarto website quantumjitter.com focuses on a data science technique or machine learning model to analyse real-world data. At the foot of each of these is a quantified view of the R packages and functions used in the associated code. This is achieved by including used_here()
in each Quarto document.
used_there()
scrapes all the tables created by used_here()
to enable a Favourite Things article on how packages and functions are used across the website.
I personally find this approach makes it easier for me to check for consistency of usage, acknowledge the packages I most need to keep abreast of (or go deeper on), and spot opportunities for updates to the latest and greatest.
When the Tidyverse blog announced changes to dplyr and purrr a quick review of my Favourite Things identified a number of opportunities to try out the exciting new features. For example, dplyr introduced temporary grouping with the .by
argument for mutate and amigos. group_by()
and ungroup()
had been used many times and most of these occurrences could be replaced with the new more concise approach.
Installation
install.packages("usedthese")
Development version
To get a bug fix, or to use a feature from the development version, you can install usedthese from GitHub.
# install.packages("pak")
pak::pak("cgoo4/usedthese")