R Observatory: Metrics for autocodebook version 0.1.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

autocodebook

0.1.0Package record

Automatic Codebook and Tracking for 'Spark' and 'dplyr' Pipelines

0packages depend

1.3Kdownloads / year

19.1%test coverage

13/13flavors OK

Overview

About

Maintained by Patricia Fortes C. de MacedoCRAN page ↗GitHub ↗Issues ↗

Wraps 'dplyr' verbs (mutate, summarise, filter) to automatically capture variable metadata (type, source columns, categories, and source code), producing a codebook and eligibility tracking table with zero manual documentation. Works with both 'sparklyr' (tbl_spark) and local data frames. Adds big-data optimizations (caching, assume-unique counting, checkpointing) and a standardized report module with an eligibility flowchart, editable codebook export (HTML, DOCX, XLSX), and cross-sectional or longitudinal variable inspection. The eligibility flowchart follows the CONSORT statement (Schulz, Altman and Moher (2010) doi:10.1136/bmj.c332) and the reporting of observational cohort studies follows the STROBE recommendations (von Elm and others (2007) doi:10.1371/journal.pmed.0040296).

Changes in 0.1.0

Initial CRAN release.
Core API: auto_mutate(), auto_summarise(), auto_filter() wrap dplyr verbs and register variable metadata (type, source columns, categories, source code) automatically.
Manual registration via cb_register(); codebook accessors via cb_get(), cb_reset(), cb_render(), cb_export() (HTML, CSV, DOCX, XLSX).
Eligibility tracking: track_step(), track_get(), track_render(), track_export().
CONSORT-style flow tree: track_split(), track_outcomes(), flow_table(), flow_get(), flow_reset().
flow_diagram() draws a publication-ready CONSORT-style flowchart (a ggplot object) from the captured eligibility steps and the flow tree: a vertical trunk (cohort baseline, aggregated exclusions box, eligible cohort), one column per subgroup, and outcome boxes stacked beneath each subgroup. The standardized report embeds it automatically.

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

flow_diagram_export() saves that flowchart by file extension: raster (.png, .jpg, .tiff), vector (.pdf, .svg, .eps), an .emf metafile editable in Word, a .docx document with the flowchart embedded as a vector image, or a .pptx slide whose boxes and labels are fully editable PowerPoint shapes. generate_report() now also writes flowchart.docx alongside the report.
Big-data optimizations for sparklyr (tbl_spark): cb_checkpoint(), per-call cache and assume_unique, session defaults via cb_set_verbose() and cb_set_default_cache().
Standardized HTML report via generate_report(), with eligibility flowchart, editable codebook export, and cross-sectional or longitudinal variable inspection.

From NEWS.md in the release

Install

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

install.packages("autocodebook", 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("patriciafortesm/autocodebook")

Development version from patriciafortesm/autocodebook. 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-autocodebook

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

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

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: 1.7 min · r-oldrel-windows-x86_64

Status changes

OK13 OK2026-09-08
ERROR12 OK, 1 ERROR2026-09-07
OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK7 OK2026-06-09

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.1.0

READMEYes · 1,116 wordsVignettesNoNEWSYes · 67% structured · mentions 0.1.0Citation fileNoWebsitenot declared in DESCRIPTION

Help pages: 26 (1 internal)includes a package overview page
Examples that run: 60%3 run in a plain check (1 of them under a condition) · 2 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples: 20%
Documented parameters: 97%
Return-value docs: 100%
Help pages citing references: 0%

How these are measured

Downloads

1.3K

CRAN downloads in the past year

Rank #13,574 · ~4/day · ~110/mo

Releases R versions

Daily download trend is not available in this view yet.

26230 days

85590 days

1.3K1 year

Compare downloads with other packages →

Also on42 r2u21 autocran

How downloads are counted

Repository

patriciafortesm/autocodebook ↗Account: patriciafortesm

3Stars

0Forks

0Open issues

0Open PRs

0Releases

27Commits

1Commit identities

27 commits · Last activity 2026-05-29 · 0% stars, 30d

Responsiveness

not measured

Stars over time

2026-06-08 · 12026-07-07 · 3

How these are measured

PracticesBeta

1 development-tooling and community-health practice detected across 1 family in the upstream repository

Checks run against github.com/patriciafortesm/autocodebook on 2026-10-22.

CRAN release process (1)

cran-comments.md

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

Dependencies

Declared dependencies

19 external dependencies (excludes base and recommended)

Installing autocodebook adds 55 packages (28 with compiled code, 36 MB of source tarballs). Heaviest: bslib 5.6 MB, gt 3.3 MB, sass 2.9 MB.

Depends (0)

none

Imports (5)

dplyr rlang tibble gtgrid

LinkingTo (0)

none

Suggests (15)

sparklyr dbplyr testthat tidyplots ggplot2 patchwork rmarkdown knitr officer flextable openxlsx scales rvg devEMF svglite

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

People & History

People (1)

Patricia Fortes C. de Macedo

Author, Maintainer since 0.1.0 (2026)

Releases (1)

0.1.0Latest
record
2026-06-08 · current release
R
R 4.6.0 released · 2026-04-24

Package metadata

First published: 2026-06-08
Total releases: 1 / 1 yrs
License: MIT + file LICENSE OSI
Download size: 465 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("autocodebook")

Format

Macedo, P. F. C. d. (2026). autocodebook: Automatic Codebook and Tracking for 'Spark' and 'dplyr' Pipelines (Version 0.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.autocodebook

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

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