Learn R Programming

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

Alakazam - Immunoglobulin clonal lineage and diversity analysis

The alakazam R package provides a set of tool to investigate lymphocyte receptor clonal lineages, diversity 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 Change-O suite. 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 tool suite.
  3. Performing lineage reconstruction on clonal populations of immunoglobulin (Ig) sequences.
  4. Performing clonal abundance and diversity analysis on lymphocyte repertoires.
  5. Performing physicochemical property analyses of lymphocyte receptor sequences.

Build Instructions

Install build dependencies:

install.packages(c("devtools", "roxygen2", "testthat", "knitr", "rmarkdown"))

Building from the R console:

devtools::install_deps()
devtools::document()
devtools::build()
devtools::install()

Optionally, you can skip the vignettes:

devtools::build(vignettes=FALSE)

Copy Link

Version

Install

install.packages('alakazam')

Monthly Downloads

1,626

Version

0.2.3

License

CC BY-NC-SA 4.0

Maintainer

Jason Vander Heiden

Last Published

February 22nd, 2016

Functions in alakazam (0.2.3)

collapseDuplicates

Remove duplicate DNA sequences and combine annotations
countPatterns

Count sequence patterns
calcDiversity

Calculate the diversity index
DiversityTest-class

S4 class defining diversity significance
extractVRegion

Extracts FWRs and CDRs from IMGT-gapped sequences
bulk

Calculates the average bulkiness of amino acid sequences
aliphatic

Calculates the aliphatic index of amino acid sequences
countClones

Tabulates clones sizes
DEFAULT_COLORS

Default colors
calcCoverage

Calculate sample coverage
translateDNA

Translate nucleotide sequences to amino acids
estimateAbundance

Estimates the complete clonal relative abundance distribution
countGenes

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

Calculate distance between two sequences
testDiversity

Pairwise test of the diversity index
testSeqEqual

Test DNA sequences for equality.
ABBREV_AA

Amino acid abbreviation translations
readChangeoDb

Read a Change-O tab-delimited database file
getSegment

Get Ig segment allele, gene and family names
getDNAMatrix

Build a DNA distance matrix
makeChangeoClone

Generate a ChangeoClone object for lineage construction
ExampleTrees

Example Ig lineage trees
buildPhylipLineage

Infer an Ig lineage using PHYLIP
alakazam

The alakazam package
makeTempDir

Create a temporary folder
writeChangeoDb

Write a Change-O tab-delimited database file
rarefyDiversity

Generate a clonal diversity index curve
plotAbundance

Plots a clonal abundance distribution
gravy

Calculates the hydrophobicity of amino acid sequences
aminoAcidProperties

Calculates amino acid chemical properties for sequence data
IMGT_REGIONS

IMGT V-segment regions
DiversityCurve-class

S4 class defining diversity curve
plotDiversityCurve

Plot the results of rarefyDiversity
maskSeqGaps

Masks gap characters in DNA sequences
multiggplot

Plot multiple ggplot objects
stoufferMeta

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

S4 class defining a clone
translateStrings

Translate a vector of strings
isValidAASeq

Validate amino acid sequences
getAAMatrix

Build an AA distance matrix
getSeqMatrix

Calculate pairwise distances between sequences
maskSeqEnds

Masks ragged leading and trailing edges of aligned DNA sequences
polar

Calculates the average polarity of amino acid sequences
charge

Calculates the net charge of amino acid sequences.
IUPAC_CODES

IUPAC ambiguous characters