Learn R Programming

Dowser

Dowser is part of the Immcantation analysis framework for Adaptive Immune Receptor Repertoire sequencing (AIRR-seq). Dowser provides a set of tools for performing phylogenetic analysis on B cell receptor repertoires. It supports building and visualizing trees using multiple methods, and implements statistical tests for discrete trait analysis of B cell migration, differentiation, and isotype switching.

Dowser has 6 primary functions:

  1. Reconstruct clonal germline sequences.
  2. Build B cell lineage trees using multiple methods, such as maximum parsimony, maximum likelihood, and IgPhyML.
  3. Reconstruct intermediate sequences within lineage trees using different methods.
  4. Create publication-quality lineage tree plots.
  5. Analyze trees to detect ongoing B cell evolution over time.
  6. Understand B cell migration and differentiation.

What's a dowser?

Contact

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

Copy Link

Version

Install

install.packages('dowser')

Monthly Downloads

520

Version

2.2.0

License

AGPL-3

Maintainer

Last Published

May 9th, 2024

Functions in dowser (2.2.0)

buildPML

Wrapper for phangorn::optim.pml
buildPratchet

Wrapper for phangorn::pratchet
collapseNodes

Collapse internal nodes with the same predicted sequence
buildClonalGermline

buildClonalGermline Determine consensus clone sequence and create germline for clone
correlationTest

Run date randomization test for temporal signal on a set of trees.
getBootstraps

Creates a bootstrap distribution for clone sequence alignments, and returns estimated trees for each bootstrap replicate as a nested list as a new input tibble column.
condenseTrees

Condense a set of equally parsimonious node labels into a single tree
downsampleClone

downsampleClone Down-sample clone to maximum tip/switch ratio
formatClones

Generate an ordered list of airrClone objects for lineage construction
buildGermline

buildGermline reconstruct germline segments from alignment data
getSubTaxa

Get the tip labels as part of a clade defined by an internal node
findSwitches

Create a bootstrap distribution for clone sequence alignments, and estimate trees for each bootstrap replicate.
createGermlines

createGermlines Determine consensus clone sequence and create germline for clone
getSubclones

#' Deprecated! Use resolveLightChains
getDivergence

Get divergence from root of tree for each tip
maskSequences

maskSequences Mask codons split by insertions in V gene
getTrees

Estimate lineage tree topologies, branch lengths, and internal node states if desired
makeAirrClone

Generate a airrClone object for lineage construction
resolvePolytomies

Resolve polytomies to have the minimum number of single timepoint clades
getGermline

getGermline get germline segment from specified receptor and segment
resolveLightChains

Define subgroups within clones based on light chain rearrangements
getNodeSeq

Return IMGT gapped sequence of specified tree node
readLineages

Read in all trees from a lineages file
getSeq

Deprecated! Use getNodeSeq
readModelFile

Read in a parsimony model file
getPalette

Get a color palette for a predefined set of trait values. 'Germline' defaults to black unless specified.
testSP

Performs SP (switch proportion) test on switch data
dowser-package

dowser: B Cell Receptor Phylogenetics Toolkit
rerootTree

Reroot phylogenetic tree to have its germline sequence at a zero-length branch to a node which is the direct ancestor of the tree's UCA. Assigns uca to be the ancestral node to the tree's germline sequence, as germid as the tree's germline sequence ID.
reconIgPhyML

Do IgPhyML maximum parsimony reconstruction
runCorrelationTest

Run correlationTest, based on https://doi.org/10.1111/2041-210X.12466
writeLineageFile

Write lineage file for IgPhyML use
stitchRegions

stitchRegions Similar to stitchVDJ but with segment IDs instead of nulecotides
stitchVDJ

stitchVDJ combines germline gene segments to a single string
plotTrees

Plot a tree with colored internal node labels using ggtree
treesToPDF

Simple function for plotting a lot of trees into a pdf
readFasta

Read a fasta file into a list of sequences readFasta reads a fasta file
maskCodons

maskCodons Masks codons split by insertions
dowser

The dowser package
makeModelFile

Make a parsimony model file
testPS

Performs PS (parsimony score) test on switch data
readIMGT

readIMGT read in IMGT database
testSC

Performs SC (switch count) test on switch data
scaleBranches

Scale branch lengths to represent either mutations or mutations per site.
bootstrapTrees

Deprecated! Please use findSwitches instead.
ExampleMixedClones

Example Multiple Partition Trees
airrClone-class

S4 class defining a clone in Dowser
BiopsyTrees

Example Ig lineage trees with biopsy reconstructions.
ExampleAirr

Example AIRR database
IsotypeTrees

Example Ig lineage trees with isotype reconstructions.
ExampleDbChangeo

Example Change-O database
ExampleMixedDb

Example Change-O database
ExampleClones

Example Ig lineage trees
colorTrees

Get a color palette for a predefined set of trait values
buildRAxML

Wrapper to build RAxML-ng trees and infer intermediate nodes
calcRF

Finds the Robinson-Fould's cluster distance between phylogenies.
buildPhylo

Wrapper for alakazam::buildPhylipLineage
TimeTrees

Example Ig lineage trees sampled over time.
buildIgphyml

Wrapper to build IgPhyML trees and infer intermediate nodes