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.

Contact

For help and questions please contact the Immcantation Group or use the issue tracker.

Copy Link

Version

Install

install.packages('alakazam')

Monthly Downloads

1,626

Version

0.2.11

License

CC BY-SA 4.0

Maintainer

Jason Vander Heiden

Last Published

September 14th, 2018

Functions in alakazam (0.2.11)

ExampleTrees

Example Ig lineage trees
baseTheme

Standard ggplot settings
cpuCount

Available CPU cores
estimateAbundance

Estimates the complete clonal relative abundance distribution
getDNAMatrix

Build a DNA distance matrix
getMRCA

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

Calculate pairwise distances between sequences
padSeqEnds

Pads ragged ends of aligned DNA sequences
DiversityCurve-class

S4 class defining a diversity curve
progressBar

Standard progress bar
rarefyDiversity

Generate a clonal diversity index curve
calcCoverage

Calculate sample coverage
ChangeoClone-class

S4 class defining a clone
extractVRegion

Extracts FWRs and CDRs from IMGT-gapped sequences
makeChangeoClone

Generate a ChangeoClone object for lineage construction
calcDiversity

Calculate the diversity index
makeTempDir

Create a temporary folder
getAAMatrix

Build an AA distance matrix
DEFAULT_COLORS

Default colors
DiversityTest-class

S4 class defining diversity significance
readChangeoDb

Read a Change-O tab-delimited database file
buildPhylipLineage

Infer an Ig lineage using PHYLIP
seqDist

Calculate distance between two sequences
writeChangeoDb

Write a Change-O tab-delimited database file
bulk

Calculates the average bulkiness of amino acid sequences
alakazam

The alakazam package
aliphatic

Calculates the aliphatic index of amino acid sequences
groupGenes

Group sequences by gene assignment
isValidAASeq

Validate amino acid sequences
tableEdges

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

Remove duplicate DNA sequences and combine annotations
countClones

Tabulates clones sizes
testDiversity

Pairwise test of the diversity index
getPathLengths

Calculate path lengths from the tree root
getSegment

Get Ig segment allele, gene and family names
permuteLabels

Permute the node labels of a tree
EdgeTest-class

S4 class defining edge significance
plotAbundanceCurve

Plots a clonal abundance distribution
ExampleDb

Example Change-O database
seqEqual

Test DNA sequences for equality.
ABBREV_AA

Amino acid abbreviation translations
AbundanceCurve-class

S4 class defining a clonal abundance curve
sortGenes

Sort V(D)J genes
IUPAC_CODES

IUPAC ambiguous characters
charge

Calculates the net charge of amino acid sequences.
countPatterns

Count sequence patterns
maskSeqEnds

Masks ragged leading and trailing edges of aligned DNA sequences
MRCATest-class

S4 class defining edge significance
countGenes

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

Check data.frame for valid columns and issue message if invalid
plotDiversityCurve

Plot the results of rarefyDiversity
testEdges

Tests for parent-child annotation enchrichment in lineage trees
plotEdgeTest

Plot the results of an edge permutation test
maskSeqGaps

Masks gap characters in DNA sequences
plotMRCATest

Plot the results of a founder permutation test
testMRCA

Tests for MRCA annotation enrichment in lineage trees
gravy

Calculates the hydrophobicity of amino acid sequences
gridPlot

Plot multiple ggplot objects
translateDNA

Translate nucleotide sequences to amino acids
plotDiversityTest

Plot the results of TestDiversity
translateStrings

Translate a vector of strings
pairwiseDist

Calculate pairwise distances between sequences
stoufferMeta

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

Generate subtree summary statistics for a tree
pairwiseEqual

Calculate pairwise equivalence between sequences
plotSubtrees

Plots subtree statistics for multiple trees
polar

Calculates the average polarity of amino acid sequences
IMGT_REGIONS

IMGT V-segment regions
aminoAcidProperties

Calculates amino acid chemical properties for sequence data