alakazam: Immunoglobulin Clonal Lineage and Diversity Analysis

Provides immunoglobulin (Ig) sequence lineage reconstruction, diversity profiling, and amino acid property analysis.

Install the latest version of this package by entering the following in R:
install.packages("alakazam")
AuthorJason Vander Heiden [aut, cre], Namita Gupta [aut], Susanna Marquez [ctb], Daniel Gadala-Maria [ctb], Roy Jiang [ctb], Steven Kleinstein [aut, cph]
Date of publication2017-03-23 06:17:53 UTC
MaintainerJason Vander Heiden <jason.vanderheiden@yale.edu>
LicenseCC BY-SA 4.0
Version0.2.6
http://alakazam.readthedocs.org

View on CRAN

Man pages

ABBREV_AA: Amino acid abbreviation translations

alakazam: The alakazam package

aliphatic: Calculates the aliphatic index of amino acid sequences

aminoAcidProperties: Calculates amino acid chemical properties for sequence data

buildPhylipLineage: Infer an Ig lineage using PHYLIP

bulk: Calculates the average bulkiness of amino acid sequences

calcCoverage: Calculate sample coverage

calcDiversity: Calculate the diversity index

ChangeoClone-class: S4 class defining a clone

charge: Calculates the net charge of amino acid sequences.

collapseDuplicates: Remove duplicate DNA sequences and combine annotations

countClones: Tabulates clones sizes

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

countPatterns: Count sequence patterns

DEFAULT_COLORS: Default colors

DiversityCurve-class: S4 class defining diversity curve

DiversityTest-class: S4 class defining diversity significance

EdgeTest-class: S4 class defining edge significance

estimateAbundance: Estimates the complete clonal relative abundance distribution

ExampleDb: Example Change-O database

ExampleTrees: Example Ig lineage trees

extractVRegion: Extracts FWRs and CDRs from IMGT-gapped sequences

getAAMatrix: Build an AA distance matrix

getDNAMatrix: Build a DNA distance matrix

getMRCA: Retrieve the first non-root node of a lineage tree

getPathLengths: Calculate path lengths from the tree root

getSegment: Get Ig segment allele, gene and family names

gravy: Calculates the hydrophobicity of amino acid sequences

gridPlot: Plot multiple ggplot objects

IMGT_REGIONS: IMGT V-segment regions

isValidAASeq: Validate amino acid sequences

IUPAC_CODES: IUPAC ambiguous characters

makeChangeoClone: Generate a ChangeoClone object for lineage construction

makeTempDir: Create a temporary folder

maskSeqEnds: Masks ragged leading and trailing edges of aligned DNA...

maskSeqGaps: Masks gap characters in DNA sequences

MRCATest-class: S4 class defining edge significance

pairwiseDist: Calculate pairwise distances between sequences

pairwiseEqual: Calculate pairwise equivalence between sequences

permuteLabels: Permute the node labels of a tree

plotAbundance: Plots a clonal abundance distribution

plotDiversityCurve: Plot the results of rarefyDiversity

plotEdgeTest: Plot the results of an edge permutation test

plotMRCATest: Plot the results of a founder permutation test

plotSubtrees: Plots subtree statistics for multiple trees

polar: Calculates the average polarity of amino acid sequences

rarefyDiversity: Generate a clonal diversity index curve

readChangeoDb: Read a Change-O tab-delimited database file

seqDist: Calculate distance between two sequences

seqEqual: Test DNA sequences for equality.

sortGenes: Sort V(D)J genes

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

summarizeSubtrees: Generate subtree summary statistics for a tree

tableEdges: Tabulate the number of edges between annotations within a...

testDiversity: Pairwise test of the diversity index

testEdges: Tests for parent-child annotation enchrichment in lineage...

testMRCA: Tests for MRCA annotation enrichment in lineage trees

translateDNA: Translate nucleotide sequences to amino acids

translateStrings: Translate a vector of strings

writeChangeoDb: Write a Change-O tab-delimited database file

Functions

ABBREV_AA Man page
alakazam Man page
alakazam-package Man page
aliphatic Man page
aminoAcidProperties Man page
buildPhylipLineage Man page
bulk Man page
calcCoverage Man page
calcDiversity Man page
ChangeoClone Man page
ChangeoClone-class Man page
charge Man page
collapseDuplicates Man page
countClones Man page
countGenes Man page
countPatterns Man page
DEFAULT_COLORS Man page
DiversityCurve Man page
DiversityCurve-class Man page
DiversityCurve-method Man page
DiversityTest Man page
DiversityTest-class Man page
DiversityTest-method Man page
DNA_COLORS Man page
EdgeTest Man page
EdgeTest-class Man page
EdgeTest-method Man page
estimateAbundance Man page
ExampleDb Man page
ExampleTrees Man page
extractVRegion Man page
getAAMatrix Man page
getAllele Man page
getDNAMatrix Man page
getFamily Man page
getGene Man page
getMRCA Man page
getPathLengths Man page
getSegment Man page
gravy Man page
gridPlot Man page
IG_COLORS Man page
IMGT_REGIONS Man page
isValidAASeq Man page
IUPAC_AA Man page
IUPAC_CODES Man page
IUPAC_DNA Man page
makeChangeoClone Man page
makeTempDir Man page
maskSeqEnds Man page
maskSeqGaps Man page
MRCATest Man page
MRCATest-class Man page
MRCATest-method Man page
pairwiseDist Man page
pairwiseEqual Man page
permuteLabels Man page
plotAbundance Man page
plotDiversityCurve Man page
plot,DiversityCurve,missing-method Man page
plotEdgeTest Man page
plot,EdgeTest,missing-method Man page
plotMRCATest Man page
plot,MRCATest,missing-method Man page
plotSubtrees Man page
polar Man page
print,DiversityCurve-method Man page
print,DiversityTest-method Man page
print,EdgeTest-method Man page
print,MRCATest-method Man page
rarefyDiversity Man page
readChangeoDb Man page
seqDist Man page
seqEqual Man page
sortGenes Man page
stoufferMeta Man page
summarizeSubtrees Man page
tableEdges Man page
testDiversity Man page
testEdges Man page
testMRCA Man page
translateDNA Man page
translateStrings Man page
TR_COLORS Man page
writeChangeoDb Man page

Files

inst
inst/CITATION
inst/doc
inst/doc/Diversity-Vignette.Rmd
inst/doc/AminoAcids-Vignette.Rmd
inst/doc/Topology-Vignette.Rmd
inst/doc/Topology-Vignette.pdf
inst/doc/Lineage-Vignette.R inst/doc/AminoAcids-Vignette.R
inst/doc/Lineage-Vignette.Rmd
inst/doc/Diversity-Vignette.pdf
inst/doc/Topology-Vignette.R inst/doc/Diversity-Vignette.R
inst/doc/Lineage-Vignette.pdf
inst/doc/AminoAcids-Vignette.pdf
inst/markr
inst/markr/build.R
src
src/RcppDistance.cpp
src/Init.c
src/RcppExports.cpp
NAMESPACE
NEWS.md
data
data/ExampleTrees.rda
data/ExampleDb.rda
R
R/Data.R R/Core.R R/AminoAcids.R R/Gene.R R/Lineage.R
R/sysdata.rda
R/RcppExports.R R/Topology.R R/Sequence.R R/Alakazam.R R/Diversity.R R/Classes.R
vignettes
vignettes/Diversity-Vignette.Rmd
vignettes/AminoAcids-Vignette.Rmd
vignettes/Topology-Vignette.Rmd
vignettes/Lineage-Vignette.Rmd
README.md
MD5
build
build/vignette.rds
DESCRIPTION
man
man/testEdges.Rd man/makeChangeoClone.Rd man/aminoAcidProperties.Rd man/buildPhylipLineage.Rd man/MRCATest-class.Rd man/pairwiseEqual.Rd man/pairwiseDist.Rd man/alakazam.Rd man/aliphatic.Rd man/writeChangeoDb.Rd man/plotAbundance.Rd man/plotSubtrees.Rd man/charge.Rd man/bulk.Rd man/getMRCA.Rd man/ExampleDb.Rd man/DEFAULT_COLORS.Rd man/tableEdges.Rd man/polar.Rd man/sortGenes.Rd man/DiversityCurve-class.Rd man/testMRCA.Rd man/EdgeTest-class.Rd man/translateStrings.Rd man/estimateAbundance.Rd man/maskSeqEnds.Rd man/DiversityTest-class.Rd man/collapseDuplicates.Rd man/getSegment.Rd man/permuteLabels.Rd man/IMGT_REGIONS.Rd man/ABBREV_AA.Rd man/countPatterns.Rd man/plotDiversityCurve.Rd man/calcDiversity.Rd man/maskSeqGaps.Rd man/IUPAC_CODES.Rd man/ChangeoClone-class.Rd man/seqDist.Rd man/stoufferMeta.Rd man/testDiversity.Rd man/plotMRCATest.Rd man/countGenes.Rd man/translateDNA.Rd man/makeTempDir.Rd man/gridPlot.Rd man/getDNAMatrix.Rd man/readChangeoDb.Rd man/seqEqual.Rd man/countClones.Rd man/calcCoverage.Rd man/ExampleTrees.Rd man/getAAMatrix.Rd man/rarefyDiversity.Rd man/gravy.Rd man/getPathLengths.Rd man/extractVRegion.Rd man/summarizeSubtrees.Rd man/isValidAASeq.Rd man/plotEdgeTest.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.