Learn R Programming

⚠️There's a newer version (1.2.0) of this package.Take me there.

SHazaM

SHazaM is part of the Immcantation analysis framework for Adaptive Immune Receptor Repertoire sequencing (AIRR-seq) and provides tools for advanced analysis of somatic hypermutation (SHM) in immunoglobulin (Ig) sequences. Shazam focuses on the following
analysis topics:

  1. Quantification of mutational load
    SHazaM includes methods for determine the rate of observed and expected mutations under various criteria. Mutational profiling criteria include rates under SHM targeting models, mutations specific to CDR and FWR regions, and physicochemical property dependent substitution rates.
  2. Statistical models of SHM targeting patterns
    Models of SHM may be divided into two independent components: (a) a mutability model that defines where mutations occur and (b) a nucleotide substitution model that defines the resulting mutation. Collectively these two components define an SHM targeting model. SHazaM provides empirically derived SHM 5-mer context mutation models for both humans and mice, as well tools to build SHM targeting models from data.
  3. Analysis of selection pressure using BASELINe
    The Bayesian Estimation of Antigen-driven Selection in Ig Sequences (BASELINe) method is a novel method for quantifying antigen-driven selection in high-throughput Ig sequence data. BASELINe uses SHM targeting models can be used to estimate the null distribution of expected mutation frequencies, and provide measures of selection pressure informed by known AID targeting biases.
  4. Model-dependent distance calculations
    SHazaM provides methods to compute evolutionary distances between sequences or set of sequences based on SHM targeting models. This information is particularly useful in understanding and defining clonal relationships.

Copy Link

Version

Install

install.packages('shazam')

Monthly Downloads

608

Version

0.1.4

License

CC BY-NC-SA 4.0

Maintainer

Jason Vander Heiden

Last Published

August 5th, 2016

Functions in shazam (0.1.4)

clearConsole

Clears the console
extendSubstitutionMatrix

Extends a substitution model to include Ns.
createTargetingModel

Creates a TargetingModel
extendMutabilityMatrix

Extends a mutability model to include Ns.
getPlatform

Determines the OS platform being used
getnproc

Determines the numbers of CPU cores available
getBaselineStats

Gets the summary statistics of a Baseline object
createSubstitutionMatrix

Builds a substitution model
createTargetingMatrix

Calculates a targeting rate matrix
distToNearest

Distance to nearest neighbor
expectedMutations

Calculate expected mutation frequencies
M1NDistance

Mouse single nucleotide distance matrix.
MRS5NFModel

Mouse 5-mer targeting model.
HS5FModel

Human 5-mer targeting model.
HS1FDistance

Human single nucleotide distance matrix.
plotBaselineDensity

Plots BASELINe probability density functions
MUTATION_SCHEMES

Amino acid mutation definitions
IMGT_SCHEMES

IMGT unique numbering schemes
groupBaseline

Group BASELINe PDFs
plotBaselineSummary

Plots BASELINe summary statistics
observedMutations

Calculate observed numbers of mutations
summarizeBaseline

Calculate BASELINe summary statistics
shazam

The shazam package
plotMutability

Plot mutability probabilities
writeTargetingDistance

Write targeting model distances to a file
testBaseline

Two-sided test of BASELINe PDFs
shmulateSeq

Simulate mutations in a single sequence
U5NModel

Uniform 5-mer targeting model.
shmulateTree

Simulate mutations in a lineage tree
createMutabilityMatrix

Builds a mutability model
createMutationDefinition

Creates a MutationDefinition
calcExpectedMutations

Calculate expected mutation frequencies of a sequence
createRegionDefinition

Creates a RegionDefinition
calcObservedMutations

Count the number of observed mutations in a sequence.
calcTargetingDistance

Calculates a 5-mer distance matrix from a TargetingModel object
collapseClones

Constructs effective clonal sequences
createBaseline

Creates a Baseline object
calcBaseline

Calculate the BASELINe PDFs