Learn R Programming

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

Alakazam

Alakazam is part of the Immcantation analysis framework for Adaptive Immune Receptor Repertoire sequencing (AIRR-seq) and provides a set of tools to investigate lymphocyte receptor clonal lineages, diversity, gene usage, and other repertoire level properties, with a focus on high-throughput immunoglobulin (Ig) sequencing.

Alakazam serves five main purposes:

  1. Providing core functionality for other R packages in the Immcantation framework. This includes common tasks such as file I/O, basic DNA sequence manipulation, and interacting with V(D)J segment and gene annotations.
  2. Providing an R interface for interacting with the output of the pRESTO and Change-O tool suites.
  3. Performing lineage reconstruction on clonal populations of Ig sequences and analyzing the topology of the resultant lineage trees.
  4. Performing clonal abundance and diversity analysis on lymphocyte repertoires.
  5. Performing physicochemical property analyses of lymphocyte receptor sequences.

Copy Link

Version

Install

install.packages('alakazam')

Monthly Downloads

1,626

Version

0.2.7

License

CC BY-SA 4.0

Maintainer

Jason Vander Heiden

Last Published

June 15th, 2017

Functions in alakazam (0.2.7)

IMGT_REGIONS

IMGT V-segment regions
IUPAC_CODES

IUPAC ambiguous characters
ABBREV_AA

Amino acid abbreviation translations
ChangeoClone-class

S4 class defining a clone
DiversityTest-class

S4 class defining diversity significance
EdgeTest-class

S4 class defining edge significance
buildPhylipLineage

Infer an Ig lineage using PHYLIP
bulk

Calculates the average bulkiness of amino acid sequences
getDNAMatrix

Build a DNA distance matrix
getMRCA

Retrieve the first non-root node of a lineage tree
DEFAULT_COLORS

Default colors
DiversityCurve-class

S4 class defining diversity curve
charge

Calculates the net charge of amino acid sequences.
collapseDuplicates

Remove duplicate DNA sequences and combine annotations
extractVRegion

Extracts FWRs and CDRs from IMGT-gapped sequences
getAAMatrix

Build an AA distance matrix
MRCATest-class

S4 class defining edge significance
alakazam

The alakazam package
countPatterns

Count sequence patterns
estimateAbundance

Estimates the complete clonal relative abundance distribution
aliphatic

Calculates the aliphatic index of amino acid sequences
aminoAcidProperties

Calculates amino acid chemical properties for sequence data
countClones

Tabulates clones sizes
countGenes

Tabulates V(D)J allele, gene or family usage.
gravy

Calculates the hydrophobicity of amino acid sequences
gridPlot

Plot multiple ggplot objects
plotSubtrees

Plots subtree statistics for multiple trees
polar

Calculates the average polarity of amino acid sequences
pairwiseEqual

Calculate pairwise equivalence between sequences
permuteLabels

Permute the node labels of a tree
rarefyDiversity

Generate a clonal diversity index curve
readChangeoDb

Read a Change-O tab-delimited database file
maskSeqGaps

Masks gap characters in DNA sequences
pairwiseDist

Calculate pairwise distances between sequences
seqDist

Calculate distance between two sequences
seqEqual

Test DNA sequences for equality.
makeTempDir

Create a temporary folder
maskSeqEnds

Masks ragged leading and trailing edges of aligned DNA sequences
summarizeSubtrees

Generate subtree summary statistics for a tree
tableEdges

Tabulate the number of edges between annotations within a lineage tree
ExampleDb

Example Change-O database
ExampleTrees

Example Ig lineage trees
calcCoverage

Calculate sample coverage
calcDiversity

Calculate the diversity index
plotAbundance

Plots a clonal abundance distribution
plotDiversityCurve

Plot the results of rarefyDiversity
testDiversity

Pairwise test of the diversity index
testEdges

Tests for parent-child annotation enchrichment in lineage trees
getPathLengths

Calculate path lengths from the tree root
getSegment

Get Ig segment allele, gene and family names
isValidAASeq

Validate amino acid sequences
makeChangeoClone

Generate a ChangeoClone object for lineage construction
testMRCA

Tests for MRCA annotation enrichment in lineage trees
translateDNA

Translate nucleotide sequences to amino acids
sortGenes

Sort V(D)J genes
stoufferMeta

Weighted meta-analysis of p-values via Stouffer's method
plotEdgeTest

Plot the results of an edge permutation test
plotMRCATest

Plot the results of a founder permutation test
translateStrings

Translate a vector of strings
writeChangeoDb

Write a Change-O tab-delimited database file