Skip to content

rworkflows

1.0.12Package record

Test, Document, Containerise, and Deploy R Packages

0packages depend
3.1Kdownloads / year
86.5%test coverage
13/13flavors OK

Overview

About

Reproducibility is essential to the progress of research, yet achieving it remains elusive even in computational fields. Continuous Integration (CI) platforms offer a powerful way to launch automated workflows to check and document code, but often require considerable time, effort, and technical expertise to setup. We therefore developed the rworkflows suite to make robust CI workflows easy and freely accessible to all R package developers. rworkflows consists of 1) a CRAN/Bioconductor-compatible R package template, 2) an R package to quickly implement a standardised workflow, and 3) a centrally maintained GitHub Action.

Changes in 1.0.12

New Features

  • Add run_lintr action input (default true) which runs lintr::lint_package() and surfaces each lint as a GitHub workflow annotation. Does not fail the workflow.
  • Add run_spelling action input (default true) which runs spelling::spell_check_package() and surfaces each misspelling as a GitHub workflow annotation. Does not fail the workflow.
  • use_workflow() now exposes matching run_lintr and run_spelling arguments, written into the generated workflow with: block.
  • run_lintr and run_spelling steps now also append a titled section to the GitHub Actions run summary ($GITHUB_STEP_SUMMARY), with per-finding details inside a collapsed <details> block. The existing inline workflow annotations are unchanged.
Show all changes in 1.0.12Hide the rest of the changes in 1.0.12

Bug Fixes

  • Comply with CRAN policy on graceful handling of unavailable internet

resources:

  • Add testthat::skip_if_offline() to all tests whose call stacks may reach the internet (test-check_bioc_version.R, test-fill_description.R, test-get_authors.R, test-get_hex.R, test-infer_biocviews.R, test-infer_deps.R).
  • Move the existing offline guard up in test-construct_cont.R so that the versions_explicit = TRUE branch (which calls bioc_r_versions()) is also skipped when offline.
  • Wrap all examples that may use internet resources in curl::has_internet() so they emit an informative message instead of erroring when offline (bioc_r_versions, construct_runners, fill_description, get_description, get_hex, infer_deps, use_badges, use_workflow).
  • Gate internet-dependent code chunks in the bioconductor and rworkflows vignettes on curl::has_internet() so vignette rebuilds degrade gracefully when offline.
  • Add curl to Suggests to support the new offline guards in examples

and vignettes.

  • Vignettes: replace read.dcf("../DESCRIPTION", ...) with utils::packageDescription("rworkflows", ...) so the setup chunks no longer fail under R CMD check's tools::checkVignettes(), which tangles each vignette to a .R file and sources it from a temp working directory where ../DESCRIPTION does not resolve. The same change is applied to inst/templates/{templateR,docker}.Rmd via a __PKG__ placeholder that use_vignette_getstarted() / use_vignette_docker() substitute at write time.
  • use_vignette_getstarted() / use_vignette_docker(): raise a clear error when package is NULL or empty (previously they silently produced a malformed file).

Miscellaneous

  • Update system requirements Ubuntu version for Linux runners in actions.
  • Bump conda-incubator/setup-miniconda from @v3 to @v4. v4 upgrades the action runtime to Node.js 24, which is supported by GitHub-hosted runners but requires self-hosted runners on a recent actions/runner release.
  • Bump actions/checkout from @v4 to @v6 (the bundled example workflow goes from @v3). v5 moved the runtime to Node.js 24 (requires runner >= v2.327.1, satisfied by all GitHub-hosted runners) and v6 persists git auth credentials to a separate .gitauth file instead of .git/config; neither change affects this action.
  • Forward the ncpus input to grimbough/bioc-actions/setup-bioc@v1 (as its Ncpus input) so non-Linux R installs use the configured parallel job count instead of the action's default of 3.
  • Tests: replace is_gha() gates that were guarding internet access with host-specific skip_if_offline(host=...) calls (bioconductor.org, github.com, raw.githubusercontent.com, ghcr.io) so individual tests skip when their actual remote is unreachable. This includes the get_description Bioc-repo block, which previously gated on is_gha() | is_rstudio() to dodge CRAN flakiness (#65); it now skips on bioconductor.org instead. Each skip_if_offline() is then wrapped in if (!is_gha()) so GitHub Actions exercises the network path regardless of the offline probe; developer machines and CRAN's check farm continue to skip when the named host is unreachable. is_gha() is also retained for the construct_conda_yml env-creation block, where the test is genuinely GHA-only (creates and leaves a conda env behind, so should not run on developer machines).

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 3.7 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-10-17
  • NOTE12 OK, 1 NOTE2026-10-01
  • OK13 OK2026-08-30
  • NOTE12 OK, 1 NOTE2026-08-28
  • OK13 OK2026-08-04
Show 6 earlier changesHide 6 earlier changes
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK13 OK2026-06-09
  • ERROR12 OK, 1 ERROR2026-06-07
  • OK12 OK2026-04-25
  • NOTE10 OK, 1 NOTE2026-03-27
  • ERROR4 OK, 1 NOTE, 1 ERROR2026-03-24
Advisories

none known

Documentation

In release 1.0.12
READMEYes · 1,180 wordsVignettesYes · 5 · dynamicNEWSYes · 100% structured · mentions 1.0.12Citation fileYes · cites a publication
Help pages
32 (9 internal)
Examples that run
91%20 run in a plain check (8 of them under a condition) · 2 never run
Exported functions with examples
100%
Documented parameters
87%
Return-value docs
100%
Help pages citing references
0%

Downloads

3.1K
CRAN downloads in the past year
Rank #8,828 · ~8/day · ~259/mo
Daily download trend is not available in this view yet.
37230 days
1.1K90 days
3.1K1 year
Compare downloads with other packages →
Also on130 r2u5 autocran1.3K conda_forge

Repository

90Stars
12Forks
31Open issues
0Open PRs
5Releases
690Commits
7Commit identities
dockerdockerhubgithub-actionscontinuous-integrationcontainersrbioconductorreproducibility
690 commits · Last activity 2026-05-06 · 0% stars, 30d · Discussions: 1 post
Responsiveness
How these are sampled
PRs merged (all time)
88%
Median days to close, 50 most recently updated closed issues
10
Median days to close, 50 most recently updated closed PRs
0

Stars over time

2025-10-10 · 802026-08-02 · 90
PracticesBeta

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

Checks run against github.com/neurogenomics/rworkflows on 2026-10-18.

Continuous integration (2)
GitHub ActionsR CMD check workflow

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

Governance and community (1)
Issue templates
Docs source (3)
README.Rmd

GitHub Pages site last deployed 2026-05-06 · The repository has a site deploy workflow

Coverage (1)
Coverage reporting
Show all practicesHide 2 practices
Reproducibility and dev environment (1)
Dev Container
Lint, format, editor (1)
Lint workflow
How this is detected·Detection ruleset v3 (2026-09-26)
AI coding toolsBeta

This repository shows signs of AI coding tools.

  • Claude Codefirst seen 2026-03-13
    Pull request it wrote: opened by a project member
    Commits: at least 5 crediting it in the message
Review tools
  • Copilot code review
    Commits: at least 1 accepting its review suggestions
Models named in its commits
  • Claude Opus 4.65 commits · Mar 2026
Counts are commits, not lines of code. Commits by a tool's accounts count once across all of its accounts. Commits crediting it are the largest count among its credit lines, a minimum.How this is detected·Detection ruleset v4 (updated 2026-09-27)

Dependencies

Declared dependencies
21 external dependencies (excludes base and recommended)

Installing rworkflows adds 51 packages (22 with compiled code, 33 MB of source tarballs). Heaviest: ggplot2 6.0 MB, data.table 5.7 MB, pak 3.8 MB.

Depends (1)
R >= 4.1
Imports (10)
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

Datasets

People & History

People (4)
Contributor, Maintainer since 1.0.10 (2026) · added in 1.0.8
Author, Contributor
Author · added in 0.99.5

Previously maintained by Brian Schilder (0.99.3 to 1.0.8).

Releases (12)

Pick two releases to compare their code metrics.

  • 1.0.12Latest
    record
    2026-05-05 · current release · diff ↗
  • R
    R 4.6.0 released · 2026-04-24
  • 1.0.11
    record
    2026-03-26 · diff ↗
  • unarchivedReturned to CRAN
    2026-03-23
  • 1.0.10
    record
    2026-03-23 · diff ↗
  • archivedRemoved from CRAN
    2026-03-03
    issues were not corrected in time
  • 1.0.8
    record
    2026-01-09 · diff ↗
  • R
    R 4.5.0 released · 2025-04-11
  • 1.0.6
    record
    2025-01-23 · diff ↗
  • unarchivedReturned to CRAN
    2024-09-22
  • 1.0.2
    record
    2024-09-22 · diff ↗
  • archivedRemoved from CRAN
    2024-09-19
    issues were not corrected in time
  • R
    R 4.4.0 released · 2024-04-24
  • unarchivedReturned to CRAN
    2024-01-18
  • 1.0.1
    record
    2024-01-18 · diff ↗
  • archivedRemoved from CRAN
    2024-01-11
    policy violation On Internet access
Show 7 earlier eventsHide 7 earlier events
  • 1.0.0
    record
    2023-11-02 · diff ↗ ·
    added 4 exports
    conda_export, construct_conda_yml, infer_docker_org, use_codespace
  • 0.99.13
    record
    2023-09-14 · diff ↗ ·
    added 1 export
    construct_cont
  • 0.99.12
    record
    2023-08-25 · diff ↗ ·
    added 8 exports
    construct_authors, dt_to_desc, fill_description, get_description, get_hex, infer_biocviews, infer_deps, is_gha
  • R
    R 4.3.0 released · 2023-04-21
  • 0.99.5
    record
    2023-01-12 · diff ↗ ·
    added 3 exports
    bioc_r_versions, construct_runners, use_issue_template
  • 0.99.3
    record
    2022-12-21
  • R
    R 4.2.0 released · 2022-04-22

Package metadata

First published
2022-12-21
Total releases
12 / 4 yrs
License
GPL-3 OSI
Minimum R
≥ 4.1
Bundled data
45 KB / 1 file
Download size
1.4 MB

Cite

Cite this package

Run in R for the authors' entry:

citation("rworkflows")

The package provides a citation file, so citation() returns the authors' own entry.

It points to 10.1038/s41467-023-44484-5.

Cite the R Observatory

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

APA

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

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

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy