R Observatory: Metrics for chronicler version 0.3.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

chronicler

0.3.0Package record

Add Logging to Functions

0packages dependsuggested by 1

3.2Kdownloads / year

65.7%test coverage

13/13flavors OK

Overview

About

Maintained by Bruno RodriguesCRAN page ↗

Decorate functions to make them return enhanced output. The enhanced output consists in an object of type 'chronicle' containing the result of the function applied to its arguments, as well as a log detailing when the function was run, what were its inputs, what were the errors (if the function failed to run) and other useful information. Tools to handle decorated functions are included, such as a forward pipe operator that makes chaining decorated functions possible.

Changes in 0.3.0

New features

read_log() now has "pretty", "table", and "errors-only" styles for viewing pipeline logs.
New write_chronicle_df function which writes data frames to .csv or .xlsx formats alongside their logs.
as.data.frame will coerce a chronicle object to data frame if its value can be coerced to data frame.
New zap_log function that resets the log of a chronicle object.
Named arguments can now be passed to functions.
ggplots can now be recorded as well. If a plot fails, it returns "an error" plot: a red box with the error message shown on it. This allows documents that use plots that might need more tweaking to still be compiled.

Chores

General code cleanup.

From NEWS.md in the release

Install

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

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

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

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-chronicler

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-chronicler

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-chronicler

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: 2.8 min · r-oldrel-windows-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 · 920 wordsVignettesYes · 4 · dynamicNEWSYes · 100% structured · mentions 0.3.0Citation fileNoWebsitenot declared in DESCRIPTION

Help pages: 19
Examples that run: 87%13 run in a plain check · 2 never run
Exported functions with examples: 88%
Documented parameters: 97%
Return-value docs: 100%
Help pages citing references: 0%

Vignettes (4)

a-non-mathematician-s-introduction-to-monads HTML
a-real-world-example HTML
Recording ggplot Objects with chronicler HTML
the-maybe-monad HTML

How these are measured

Downloads

3.2K

CRAN downloads in the past year

Rank #13,449 · ~9/day · ~265/mo

Releases R versions

Daily download trend is not available in this view yet.

35330 days

86090 days

3.2K1 year

Compare downloads with other packages →

Also on92 r2u9 autocran910 conda_forge

How downloads are counted

Dependencies

Declared dependencies

14 external dependencies (excludes base and recommended)

Installing chronicler adds 28 packages (13 with compiled code, 17 MB of source tarballs). Heaviest: ggplot2 6.0 MB, isoband 1.5 MB, farver 1.2 MB.

Depends (1)

R >= 4.1.0

Imports (7)

diffobj dplyr ggplot2 maybe rlang tibbleutils

LinkingTo (0)

none

Suggests (8)

clipr knitr lubridate openxlsx purrr rmarkdown testthat tidyr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Suggested by 1

Suggests, most downloaded first

rixpress

How these are counted

Code & Tests

Datasets

People & History

People (2)

Bruno Rodrigues

Matouš Eibich

Contributor · added in 0.3.0

Releases (4)

Pick two releases to compare their code metrics.

R
R 4.6.0 released · 2026-04-24
0.3.0Latest
record
2025-08-18 · current release · diff ↗ ·
removed 1 export
pick

added 4 exports
record_ggplot, unveil, write_chronicle_df, zap_log
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
0.2.2
record
2024-03-20 · diff ↗
R
R 4.3.0 released · 2023-04-21
0.2.1
record
2023-02-03 · diff ↗
0.2.0
record
2022-05-17
R
R 4.2.0 released · 2022-04-22

Package metadata

First published: 2022-05-17
Total releases: 4 / 4 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 4.1.0
Bundled data: 214 KB / 1 file
Download size: 389 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("chronicler")

Format

Rodrigues, B., & Eibich, M. (2025). chronicler: Add Logging to Functions (Version 0.3.0) [Computer software]. https://doi.org/10.32614/CRAN.package.chronicler

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 chronicler version 0.3.0 [Data set]. HJJB, LLC. Data release v2026-10-22. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-22, 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 →