R Observatory: Metrics for plume version 0.3.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

plume

0.3.0Package record

A Simple Author Handler for Scientific Writing

0packages depend

2.9Kdownloads / year

95.6%test coverage

13/13flavors OK

Overview

About

Maintained by Arnaud GallouCRAN page ↗GitHub ↗Website ↗Issues ↗

Handles and formats author information in scientific writing in 'R Markdown' and 'Quarto'. 'plume' provides easy-to-use and flexible tools for inserting author data in 'YAML' as well as generating author and contribution lists (among others) as strings from tabular data.

Changes in 0.3.0

New features

New new_plume() and new_plume_quarto() that are aliases for Plume$new() and PlumeQuarto$new(), respectively (#124).
New plm_symbols() to set the symbols used in Plume (#119).
Plume$new() and PlumeQuarto$new() gain a new parameter dotted_initials to control whether or not initials should be dotted. This parameter replaces the dotted_initials parameter of $get_contributions(), which is now deprecated (#112).
Plume$new() gains a new parameter distinct_initials to differentiate similar authors' initials, when possible. This is done by adding extra letters from the last word of authors' family name until initials are unique. Initials will remain in the short form if authors share the same family name (#111).
New as_lines() to output vector elements on distinct lines when rendering an R Markdown or Quarto document (#98).

Breaking changes

Setting new default names to a plume subclass must now be done via the names field (#117).

Minor improvements and bug fixes

$get_author_list() now correctly drops leading ^ when there are no symbols to display (#127).
ORCID icons are now ignored in Quarto documents due to a change introduced in Quarto 1.5 regarding how paths are resolved. They continue to work in R Markdown as before (#109).
Plume now automatically escapes special Markdown characters used as symbols (#119).

Show all changes in 0.3.0Hide the rest of the changes in 0.3.0

$set_*() methods are now dot-agnostic (#113).
The orcid variable is now customisable (#96).

Lifecycle changes

All functionalities deprecated in 0.2.1 and earlier now throw an error. This includes:
The credit_roles parameter in plm_template() and $new().
The format parameter in $get_author_list().
The by parameter in $set_*() methods.
everyone_but().
$set_equal_contributor().
Defining authors' roles explicitly in the input dataset.

Newly deprecated

$get_plume() is deprecated in favour of $data() (#115).
$get_roles() is deprecated in favour of $roles() (#114).
The dotted_initials parameter of $get_contributions() is now deprecated. This parameter must now be set in the constructors (#112).
orcid() is deprecated in favour of icn_orcid() (#105).
The format parameter of $get_contact_details() is now deprecated in favour of the more explicit template parameter (#104).

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("plume", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("arnaudgallou/plume")

Development version from arnaudgallou/plume. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-plume

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-plume

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-plume

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 3.7 min · r-oldrel-macos-x86_64

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.3.0

READMEYes · 408 wordsVignettesYes · 4 · dynamicNEWSYes · 100% structured · mentions 0.3.0Citation fileNoWebsiteYes · pkgdown

Help pages: 18 (7 internal)includes a package overview page
Examples that run: 100%12 run in a plain check
Exported functions with examples: 92%
Documented parameters: 88%
Return-value docs: 75%
Help pages citing references: 0%

Vignettes (4)

How these are measured

Downloads

2.9K

CRAN downloads in the past year

Rank #16,055 · ~8/day · ~239/mo

Releases R versions

Daily download trend is not available in this view yet.

30330 days

78490 days

2.9K1 year

Compare downloads with other packages →

Also on75 r2u5 autocran

How downloads are counted

Repository

arnaudgallou/plume ↗Account: arnaudgallou

23Stars

2Forks

3Open issues

0Open PRs

8Releases

393Commits

1Commit identities

authorsrpreprintcontributionlistpaperrolecontributions

License file reads as GPL-3.0 · 393 commits · Last activity 2026-08-19 · 0% stars, 30d · Default branch at 0.3.0.9000, ahead of CRAN 0.3.0 (checked 2026-10-25)

Responsiveness

How these are sampled

PRs merged (all time): 99%
Median days to close, 50 most recently updated closed issues: 3
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

2025-05-14 · 212026-08-15 · 23

How these are measured

PracticesBeta

11 development-tooling and community-health practices detected across 6 families in the upstream repository

Checks run against github.com/arnaudgallou/plume on 2026-10-25.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (4)

README.Rmdpkgdown

GitHub Pages site last deployed 2026-08-19 · The repository has a site deploy workflow

pkgdown site last built 2025-09-27

Coverage (2)

Coverage reporting (Codecov).covrignore

Reproducibility and dev environment (1)

data-raw/

Show all practicesHide 2 practices

CRAN release process (1)

cran-comments.md

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

22 external dependencies (excludes base and recommended)

Installing plume adds 36 packages (20 with compiled code, 22 MB of source tarballs). Heaviest: stringi 11 MB, jsonlite 1.0 MB, vctrs 1.0 MB.

Depends (1)

R >= 4.1.0

Imports (15)

dplyr glue jsonlite knitr lifecycle purrr R6 readr rlang stringr tibble tidyr tidyselect vctrs yaml (>= 2.3.8)

LinkingTo (0)

none

Suggests (7)

covr fontawesome gt rmarkdown testthat waldo withr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

Datasets

People & History

People (1)

Arnaud Gallou

Listed in earlier versions (1)

Hadley Wickham

no longer listed · 0.1.0

Releases (8)

Pick two releases to compare their code metrics.

R
R 4.6.0 released · 2026-04-24
0.3.0Latest
record
2025-09-27 · current release · diff ↗ ·
added 5 exports
as_lines, icn_orcid, new_plume, new_plume_quarto, plm_symbols
R
R 4.5.0 released · 2025-04-11
0.2.5
record
2024-09-02 · diff ↗
0.2.4
record
2024-05-10 · diff ↗
R
R 4.4.0 released · 2024-04-24
0.2.3
record
2024-01-29 · diff ↗
0.2.2
record
2024-01-09 · diff ↗
0.2.1
record
2023-12-09 · diff ↗
0.2.0
record
2023-11-30 · diff ↗ ·
added 1 export
credit_roles
0.1.0
record
2023-10-06
R
R 4.3.0 released · 2023-04-21

Package metadata

First published: 2023-10-06
Total releases: 8 / 3 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 4.1.0
Bundled data: 1.0 KB / 2 files
Download size: 87 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("plume")

Format

Gallou, A. (2025). plume: A Simple Author Handler for Scientific Writing (Version 0.3.0) [Computer software]. https://doi.org/10.32614/CRAN.package.plume

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for plume version 0.3.0 [Data set]. HJJB, LLC. Data release v2026-10-26. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-26, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →