Immunoglobulin Somatic Hypermutation Analysis
Overview
Provides a computational framework for analyzing mutations in immunoglobulin (Ig) sequences. Includes methods for Bayesian estimation of antigen-driven selection pressure, mutational load quantification, building of somatic hypermutation (SHM) models, and model-dependent distance calculations. Also includes empirically derived models of SHM for both mice and humans. Citations: Gupta and Vander Heiden, et al (2015) doi:10.1093/bioinformatics/btv359, Yaari, et al (2012) doi:10.1093/nar/gks457, Yaari, et al (2013) doi:10.3389/fimmu.2013.00358, Cui, et al (2016) doi:10.4049/jimmunol.1502263.
Backwards Incompatible Changes:
- Removed the unused
cloneColumnargument fromobservedMutations(),expectedMutations(), andcalcBaseline(). Calls that still passcloneColumnwill now fail with an "unused argument" error and must drop the argument. Results are unchanged, as the argument was never used.
Distance Profiling:
findThreshold(method="gmm")results can now be reproduced by callingset.seed()beforehand. Previously, the fitting procedure reset the random number generator internally, so results differed between runs and the caller's random number generator state was overwritten.- Improved the speed and memory usage of
distToNearest()when assigning sequences to groups.
Show all changes in 1.4.0Hide the rest of the changes in 1.4.0
Targeting Models:
- Fixed the built-in
U5Ntargeting model, which was missing thenumMutSandnumMutRslots and would error (no slot of name "numMutS"...) on any operation reading those slots. Model values are unchanged.
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-05-10
- ERROR12 OK, 1 ERROR2026-05-03
- OK12 OK2026-04-25
Show 2 earlier changesHide 2 earlier changes
- ERROR13 OK, 1 ERROR2026-03-30
- OK14 OK2026-03-10
Documentation
- Help pages
- 66 (1 internal)includes a package overview page
- Examples that run
- 62%29 run in a plain check · 15 only when donttest examples are enabled (R CMD check --as-cran) · 3 never run
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 91%
- Help pages citing references
- 32%
Downloads
Repository
- PRs merged (all time)
- 92%
- Median days to close, 50 most recently updated closed issues
- 34
- Median days to close, 50 most recently updated closed PRs
- 5
Stars over time
Forks over time
Issues over time
PRs over time
Commits over time
7 development-tooling and community-health practices detected across 3 families in the upstream repository
Checks run against github.com/immcantation/shazam on 2026-10-11.
The R CMD check workflow runs on Linux
This repository shows signs of AI coding tools.
- GitHub Copilotfirst seen 2025-12-12Pull request: opened by its own accountCommits: 4 by its own account
Dependencies
Installing shazam adds 58 packages (33 with compiled code, 55 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, igraph 4.8 MB. 3 more not on CRAN are not measured.
Code & Tests
Datasets
People & History
Previously maintained by Jason Vander Heiden (0.1.2 to 1.1.2).
Pick two releases to compare their code metrics.
- 1.4.0Latest
- RR 4.6.0 released · 2026-04-24
- 1.3.22026-01-08 · diff ↗
- 1.3.12026-01-08 · diff ↗
- 1.3.02025-10-20 · diff ↗
- RR 4.5.0 released · 2025-04-11
- RR 4.4.0 released · 2024-04-24
- 1.2.02023-10-02 · diff ↗
- RR 4.3.0 released · 2023-04-21
- 1.1.2
- 1.1.1
- RR 4.2.0 released · 2022-04-22
- 1.1.0
- RR 4.1.0 released · 2021-05-18
- 1.0.22020-08-11 · diff ↗
- 1.0.12020-07-19 · diff ↗
Show 21 earlier eventsHide 21 earlier events
- 1.0.02020-05-11 · diff ↗
- RR 4.0.0 released · 2020-04-24
- 0.2.32020-02-06 · diff ↗
- 0.2.22019-12-16 · diff ↗
- 0.2.12019-07-20 · diff ↗
- 0.2.0
- RR 3.6.0 released · 2019-04-26
- 0.1.112019-01-28 · diff ↗
- 0.1.10
- RR 3.5.0 released · 2018-04-23
- 0.1.9
- 0.1.82017-06-30 · diff ↗
- 0.1.72017-05-14 · diff ↗
- 0.1.62017-05-13 · diff ↗
- RR 3.4.0 released · 2017-04-21
- 0.1.52017-03-24 · diff ↗ ·
added 15 exports
editBaseline, findThreshold, makeAverage1merMut, makeAverage1merSub, makeDegenerate5merMut, makeDegenerate5merSub, minNumMutationsTune, minNumSeqMutationsTune, plotDensityThreshold, plotGmmThreshold, plotTune, slideWindowDb, slideWindowSeq, slideWindowTune, slideWindowTunePlot - 0.1.42016-08-06 · diff ↗
- 0.1.32016-07-31 · diff ↗ ·
removed 3 exports
calcDBExpectedMutations, calcDBObservedMutations, collapseByCloneadded 6 exports
collapseClones, expectedMutations, observedMutations, shmulateSeq, shmulateTree, testBaseline - RR 3.3.0 released · 2016-05-03
- 0.1.22016-02-21
- RR 3.2.0 released · 2015-04-16
Package metadata
- First published
- 2016-02-21
- Total releases
- 25 / 10 yrs
- License
- AGPL-3 OSI · relicensed from CC BY-SA 4.0 in 1.0.0
- Minimum R
- ≥ 4.0
- Bundled data
- 464 KB / 17 files
- Download size
- 1.7 MB
Cite
Cite this package
Run in R for the authors' entry:
citation("shazam")The package provides a citation file, so citation() returns the authors' own entry.
It points to 10.1093/bioinformatics/btv359, 10.1093/nar/gks457, 10.3389/fimmu.2013.00358, 10.4049/jimmunol.1502263, 10.3389/fimmu.2018.01687.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-19, which the citation names so these numbers can be found later. More on citing and the projects behind them.