rcompendium

1.4

Create a Package or Research Compendium Structure

0packages depend

10Kdownloads / year

6.8%test coverage

13/13checks pass

Overview

About

Maintained by Nicolas CasajusFirst published 2021-03-246 releasesCRAN page ↗GitHub ↗

Makes easier the creation of R package or research compendium (i.e. a predefined files/folders structure) so that users can focus on the code/analysis instead of wasting time organizing files. A full ready-to-work structure is set up with some additional features: version control, remote repository creation, CI/CD configuration (check package integrity under several OS, test code with 'testthat', and build and deploy website using 'pkgdown'). This package heavily relies on the R packages 'devtools' and 'usethis' and follows recommendations made by Wickham H. (2015) <ISBN:9781491910597> and Marwick B. et al. (2018) doi:10.7287/peerj.preprints.3192v2.

Install

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

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

Development version from FRBCesab/rcompendium. 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-rcompendium

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

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

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

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 3.0 min · r-oldrel-windows-x86_64

Code health

Yes

Tests · ratio 0.04

6.8%

Coverage · measured lines

100%

Documentation · exports

Dependencies · direct

Check history

OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 452 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 2%
Documented parameters: 100%
Return-value docs: 100%
References docs: 0%

Downloads

10K

CRAN downloads in the past year

Rank #4,428 · ~27/day · ~832/mo

Releases R versions

Daily download trend is not available in this view yet.

36630 days

2K90 days

10K1 year

Compare downloads with other packages →

Also on113 r2u750 conda_forge22 c2d4u

Repository

GitHub ↗ frbcesab/rcompendium

40Stars

10Forks

21Open issues

1Open PRs

6Releases

458Commits

5Contributors

rpackageresearch-compendiumreproducible-research

License GPL-2.0 · 458 commits · Last activity 2026-07-08 · 0% stars, 30d

Stars over time

2025-02-17 · 392026-07-07 · 40

Repository practices

Upstream repositoryBeta

8 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/frbcesab/rcompendium on 2026-07-30.

Continuous integration (1)

GitHub Actions

Docs source (1)

README.Rmd

Research and citation (2)

CITATION.cffcodemeta.json

Lint, format, editor (2)

AirVS Code

Show all practices

Governance and community (2)

Issue templatesCODEOWNERS

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

17 external dependencies (excludes base and recommended)

Depends (1)

R >= 2.10

Imports (14)

cffr cli codemetar devtools gert gh gtools renv rmarkdown rstudioapi stringr usethisutilsxfun

LinkingTo (0)

none

Suggests (4)

fs knitr testthat withr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (1)

Maintainer (1)

Nicolas Casajus

Author, Maintainer, Copyright holder

Authors (1)

Nicolas Casajus

Author, Maintainer, Copyright holder

Nicolas Casajus

Author, Maintainer, Copyright holder

Package Timeline

6 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
1.4Latest
2025-09-02 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
1.3
2023-10-26 · diff ↗
1.2
2023-10-24 · diff ↗
1.1
2023-04-24 · diff ↗
R
R 4.3.0 released · 2023-04-21
R
R 4.2.0 released · 2022-04-22
1.0
2022-04-06 · diff ↗
R
R 4.1.0 released · 2021-05-18
0.5.1
2021-03-24
R
R 4.0.0 released · 2020-04-24

Package metadata

First published: 2021-03-24
Total releases: 6 / 5 yrs
License: GPL (>= 2) OSI
Minimum R: ≥ 2.10
Download size: 633 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Appears in task views

Reproducible Research

Report a problem with this page →