Skip to content

intraclass

0.1.0Package record

Modern Intraclass Correlation Coefficients

0packages depend
504downloads / year
–test coverage
13/13flavors OK

Overview

About

Estimates interrater-reliability intraclass correlation coefficients (ICCs) within the generalizability-theory framework using modern variance-component estimation (linear mixed models) rather than the classical analysis-of-variance mean-squares approach. Provides the full ICC family (absolute agreement versus consistency, single versus average, fixed versus random raters, one-way versus two-way) with boundary-aware Monte-Carlo confidence intervals, support for imbalanced, incomplete, and multilevel (nested) designs, decision-study projection to other numbers of raters, and an interactive helper for choosing the correct coefficient. Multilevel methods follow ten Hove, Jorgensen and van der Ark (2022) doi:10.1037/met0000391.

Changes in 0.1.0

First public release.

**intraclass** estimates interrater-reliability intraclass correlation

coefficients (ICCs) within the generalizability-theory framework. Variance

components come from a linear mixed model rather than from classical ANOVA

mean squares. A point estimate is never reported without an interval, and

ci_method selects which interval that is. The package requires R 4.5.0 or

newer.

What ships

  • icc() fits the model and reports the ICC family the design defines: absolute agreement or consistency (type), single or average (unit), random or fixed raters (raters), one-way or two-way (model). See *Getting started* and ?icc.
Show all changes in 0.1.0Hide the rest of the changes in 0.1.0
  • Data need not form a complete, balanced grid. There is support for imbalanced, incomplete, and multilevel (nested) designs: unequal ratings per subject, missing ratings, and subjects nested in a higher-level unit such as a classroom or clinic. A cluster column on a two-way design switches on the multilevel ICC, adding a cluster level when the same raters span every cluster. See *Multilevel designs: subject and cluster level* and ?icc for the layouts and where it refuses.
  • Rating a subject-by-rater cell more than once gives a within-cell replicate design. On a two-way random design icc() splits the single-rating residual into a subject-by-rater interaction and pure error, and occasions reports the reliability of one rating or, on balanced replicates, of the mean. See *D-studies and within-cell replicates* and ?icc for the designs replicates support and where they refuse.
  • d_study() projects a fitted reliability to other numbers of raters (m) or occasions (n_o), with a plot() and ggplot2::autoplot() curve. *D-studies and within-cell replicates* gives the designs each projection supports and where it refuses.
  • choose_icc() recommends which coefficient or coefficients to report, explains the reasoning, and prints the icc() call to run. Its type, unit and level questions each take "both", which asks for the pair rather than making you choose one. It gives advice only. See *Choosing an ICC*.
  • tidy() and glance() return tidy summaries of a fit or a projection. print(), format(), plot() and ggplot2::autoplot() methods are provided for both classes, and summary() for an icc() fit. ggplot2 is a Suggests dependency.
  • Datasets ratings and ratings_incomplete, used throughout the documentation.
  • Eight articles: *Getting started*, *Choosing an ICC*, *Multilevel designs: subject and cluster level*, *Estimation engines*, *Confidence-interval methods*, *D-studies and within-cell replicates*, *Glossary*, and *Comparison with other packages*.

Engines

  • The default engine is **glmmTMB**, the package's only hard engine dependency. engine = "lme4", engine = "lavaan" and engine = "brms" are selectable. Which designs each engine covers, and where it refuses, is documented in *Estimation engines* and ?icc.
  • The **brms** engine fits both random- and fixed-rater models under a sourced half-*t*(4, 0, 1) prior on every random-effect standard deviation. Its point estimate is the posterior mode and its interval a percentile **credible** interval, so ci_method = "posterior" is forced. Supplying a custom prior is a deliberate deviation: icc() warns, and the coverage results this package reports no longer apply.
  • The lme4 package itself is already on your library path after a plain install, because glmmTMB lists it in its own Imports, but the lme4 engine also needs **merDeriv**, which does not arrive. merDeriv, lavaan and brms sit in this package's Suggests, and a plain install fetches none of the three.

Confidence intervals

  • ci_method selects the interval: "montecarlo" (the default), "bootstrap", "npbootstrap", "searle", "burch", "mpl", and "posterior" under **brms**. Where a method does not apply to the design, the call aborts with a classed error. *Confidence-interval methods* compares them; ?icc gives the per-method conditions.
  • Interval coverage was studied by simulation before release, and the limitations those studies found are documented rather than smoothed over. The Monte-Carlo default under-covers when the subject effects are strongly skewed or heavy-tailed, worst 0.6725 at chi-square(1) subject effects with a true ICC of 0.6, 50 subjects and 5 raters. "burch" is no remedy there (worst 0.6655).
  • "searle" and "burch" are the two classical closed forms, and the three grids below measure their widths: the smaller grid's 16 cells and the larger grid's 64 cells draw only the subject effects from the non-normal family. The third draws the residual from the same family as the subject effect.
  • Which of the two closed forms gives the **narrower** interval is conditional. On both grids that vary only the subject effect, "burch" is the narrower of the two in 16 of 16 cells of the smaller grid and 59 of 64 cells of the larger grid.
  • That width margin holds much the same up to a true ICC of 0.3 rather than shrinking as the true ICC rises (on the larger grid; the smaller grid's margin does shrink across its levels). The "burch" width advantage then collapses to near parity at a true ICC of 0.6, on the one grid reaching that value. It also shrinks steadily as the subject count grows, measured at 5 raters.
  • What "burch" does against "searle" also depends on the residual, and the three grids measure that: the two grids that vary only the subject effect put it narrower nearly everywhere, while the third, which draws the residual from the same family as the subject effect, puts it wider at every symmetric heavy-tailed family measured (a median width ratio of 1.2963 at t(5) with 100 subjects) and narrower at every lighter-tailed one, the normal included.
  • The ci_method = "mpl" documentation states the interpolation evidence behind off-node subject counts. The correction constant is calibrated at subject-count nodes and linearly interpolated between them. The interpolated path is coverage-validated at each supported confidence level, at the default 0.95 by three off-node cells, each clearing its pre-registered coverage floor. The documentation also says what that validation does not establish (interpolated values are validated at a handful of geometries, not calibrated, and the interval's asymmetry direction is not uniform across rater counts). Every universal or negative claim this documentation makes about the validated cells is settled mechanically, in CI, against the committed coverage fixture (data-raw/check-mpl-doc-claims.py).

When a call fails

  • Errors are classed and name the quantities that failed the check, rather than asserting a cause. Where an interval method aborts on degenerate data, the error names another ci_method only after running it on your data and confirming it returns a usable interval.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 12.4 min · r-devel-linux-x86_64-debian-clang
Status changes
  • OK13 OK2026-10-12
  • ERROR12 OK, 1 ERROR2026-10-09
  • OK13 OK2026-10-08
  • ERROR12 OK, 1 ERROR2026-10-06
  • OK6 OK2026-09-11
Advisories

none known

Documentation

In release 0.1.0
READMEYes · 737 wordsVignettesYes · 8 · evaluation depends on the environmentNEWSYes · 67% structured · mentions 0.1.0Citation fileNoWebsiteYes · pkgdown
Help pages
7 (2 internal)includes a package overview page
Examples that run
100%5 run in a plain check (2 of them under a condition)
Exported functions with examples
75%
Documented parameters
80%
Return-value docs
75%
Help pages citing references
29%

Downloads

504
CRAN downloads in the past year
Rank #24,058 · ~1/day · ~42/mo
Daily download trend is not available in this view yet.
36730 days
50490 days
5041 year
Compare downloads with other packages →
Also on7 r2u4 autocran

Repository

0Stars
0Forks
0Open issues
0Open PRs
1Releases
649Commits
1Commit identities
649 commits · Last activity 2026-10-18 · Default branch at 0.1.0.9000, ahead of CRAN 0.1.0 (checked 2026-10-11)
Responsiveness
How these are sampled
PRs merged (all time)
99%
Median days to close, 50 most recently updated closed issues
not measured
Median days to close, 50 most recently updated closed PRs
0

Commits over time

2026-09-15 · 6042026-10-18 · 649
PracticesBeta

14 development-tooling and community-health practices detected across 7 families in the upstream repository

Checks run against github.com/jmgirard/intraclass on 2026-10-11.

Continuous integration (2)
GitHub ActionsR CMD check workflow

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

Governance and community (1)
Contributing guide
Docs source (4)
README.Rmdpkgdown

GitHub Pages site last deployed 2026-10-11 · The repository has a site deploy workflow

pkgdown site last built 2026-10-11

Coverage (1)
Coverage reporting
Show all practicesHide 3 practices
Reproducibility and dev environment (1)
data-raw/
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Lint, format, editor (3)
lintrLint workflowAir
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-07-06
    Seen in the repository: .claude, .claude/agents, CLAUDE.md
    Named in .Rbuildignore: .claude, CLAUDE.md
    Pull request it wrote: opened by a project member
    Commits: at least 400 crediting it in the message
Models named in its commits
  • Claude Opus 4.8100 commits · Jul 2026

Some of these counts are a minimum, because the search stopped before the oldest commits.

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
22 external dependencies (excludes base and recommended)

Installing intraclass adds 57 packages (33 with compiled code, 60 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, glmmTMB 5.2 MB.

Depends (1)
R >= 4.5.0
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

Datasets

People & History

People (1)
Author, Maintainer since 0.1.0 (2026)
Releases (1)
  • 0.1.0Latest
    2026-09-10 · current release
  • R
    R 4.6.0 released · 2026-04-24

Package metadata

First published
2026-09-10
Total releases
1 / 1 yrs
License
MIT + file LICENSE OSI
Minimum R
≥ 4.5.0
Bundled data
0.6 KB / 2 files
Download size
884 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("intraclass")
Girard, J. (2026). intraclass: Modern Intraclass Correlation Coefficients (Version 0.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.intraclass

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.

APA

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

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