Skip to content

Latest commit

 

History

History
110 lines (75 loc) · 4.19 KB

README.md

File metadata and controls

110 lines (75 loc) · 4.19 KB
Raw

annotater

CRAN status Codecov test coverage

The goal of annotater is to annotate package load calls in character strings and R/Rmd files, so we can have an idea of the overall purpose of the libraries we’re loading.

What do my loaded packages do?

note: the gifs below may show fewer addins than the current release but the functionality is unchanged

Where did I get them?

The two annotation types are also available together:

Thanks to Juan Cruz Rodriguez, we can now annotate which functions from each package are being called in a script.

As of version 0.2.3, loaded datasets can also be added as annotations.

pacman compatibility

Users of the pacman package can now use all annotater functions on p_load calls. This includes calls with multiple package names (e.g. p_load(ggplot2,purrr)), which will be split up across lines for readability.

Installation

Install the CRAN release or the development version with:

# Install annotater from CRAN:
install.packages("annotater")
# install.packages("remotes")
remotes::install_github("luisDVA/annotater")

Restart RStudio after the installation for the addins to load properly.

When using the addins, make sure the focus (blinking cursor) is on an open RStudio R file in the ‘source’ pane.

Example

These are the possible annotations, which can be added to character strings (with one line per element), or applied to .R or .Rmd files in RStudio through their corresponding addins.

library(annotater)
test_string <-c("library(boot)\nrequire(Matrix)")
writeLines(annotate_pkg_calls(test_string))
writeLines(annotate_repo_source(test_string))
writeLines(annotate_repo_source(test_string))

Entire .R files can also be parsed and annotated with the annotate_script function.

A note on the tidyverse

The tidyverse package is a meta-package with few exported functions of its own, so the annotation tools provided here (annotate_fun_calls) will not match the functions from the various individual packages (such as dplyr or readr) that get attached when loading tidyverse. Consider using the experimental expand_metapackages function first if annotations for function calls are desired.

More on metapackages

annotater can now expand metapackage load calls into separate library calls for the individual packages that form the core of tidyverse, tidymodels, and easystats.

Feedback welcome

Thanks to Jonathan Carroll, Firat Melih Yilmaz, Paul Schmidt, and Achaz von Hardenberg for feedback and suggestions.