dowser2.4.0 package

B Cell Receptor Phylogenetics Toolkit

airrClone-class

S4 class defining a clone in Dowser

bootstrapTrees

Deprecated! Please use findSwitches instead.

buildBeast

Read in a directory from a BEAST run. Runs treeannotator and loganalys...

buildClonalGermline

buildClonalGermline Determine consensus clone sequence and create ge...

buildGermline

buildGermline reconstruct germline segments from alignment data

buildIgphyml

Wrapper to build IgPhyML trees and infer intermediate nodes

buildPhylo

Wrapper for alakazam::buildPhylipLineage

buildPML

Wrapper for phangorn::optim.pml

buildPratchet

Wrapper for phangorn::pratchet

buildRAxML

Wrapper to build RAxML-ng trees and infer intermediate nodes

calcRF

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

checkDivergence

Compare divergence along a tree in terms of mutations (sum of branches...

collapseNodes

Collapse internal nodes with the same predicted sequence

colorTrees

Get a color palette for a predefined set of trait values

condenseTrees

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

correlationTest

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

create_alignment

Takes an airr clone object and returns BEAST2 Alignment xml of the seq...

create_height_prior

Takes an airr clone object and returns BEAST2 XML to set a height prio...

create_max_height_prior

Takes an airr clone object and returns BEAST2 XML to set a maximum hei...

create_MRCA_prior_germline

Takes an airr clone object and returns BEAST2 XML for MRCA prior of th...

create_MRCA_prior_observed

Takes an airr clone object and returns BEAST2 XML for MRCA prior of th...

create_root_freqs

Takes an airr clone object and returns BEAST2 rootfreqs xml of the ger...

create_starting_tree

Takes an airr clone object and tree and returns BEAST2 XML for setting...

create_traitset

Takes an airr clone object and returns BEAST2 XML for a trait/traitSet...

createGermlines

createGermlines Determine consensus clone sequence and create germline...

dfToFasta

Write a fasta file of sequences readFasta reads a fasta file

downsampleClone

downsampleClone Down-sample clone to maximum tip/switch ratio

dowser-package

dowser: B Cell Receptor Phylogenetics Toolkit

dowser

The dowser package

exportTrees

Exports the phylogenetic trees from the airrClone object

findSwitches

Create a bootstrap distribution for clone sequence alignments, and est...

formatClones

Generate an ordered list of airrClone objects for lineage construction

getAllSeqs

Return all tip and internal node sequences

getBootstraps

Creates a bootstrap distribution for clone sequence alignments, and re...

getDivergence

Get divergence from root of tree for each tip

getGermline

getGermline get germline segment from specified receptor and segment

getNodeSeq

Return IMGT gapped sequence of specified tree node

getPalette

Get a color palette for a predefined set of trait values. 'Germline' d...

getSeq

Deprecated! Use getNodeSeq

getSkylines

Make data frames for Bayesian skyline plots

getSubclones

#' Deprecated! Use resolveLightChains

getSubTaxa

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

getTimeTrees

Estimate time trees by running BEAST on each clone Applies XML `templa...

getTimeTreesIterate

Iteratively resume getTimeTrees until convergence, as defined by all p...

getTrees

Estimate lineage tree topologies, branch lengths, and internal node st...

makeAirrClone

Generate a airrClone object for lineage construction

makeModelFile

Make a parsimony model file

makeSkyline

get values for Bayesian Skyline plot

maskCodons

maskCodons Masks codons split by insertions

maskSequences

maskSequences Mask codons split by insertions in V gene

plotSkylines

Simple function for plotting Bayesian skyline plots

plotTrees

Plot a tree with colored internal node labels using ggtree

readBEAST

Reads in a BEAST output directory

readFasta

Read a fasta file into a list of sequences readFasta reads a fasta f...

readIMGT

readIMGT read in IMGT database

readLineages

Read in all trees from a lineages file

readModelFile

Read in a parsimony model file

reconIgPhyML

Do IgPhyML maximum parsimony reconstruction

rerootTree

Reroot phylogenetic tree to have its germline sequence at a zero-lengt...

resolveLightChains

Define subgroups within clones based on light chain rearrangements

resolvePolytomies

Resolve polytomies to have the minimum number of single timepoint clad...

runCorrelationTest

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

sampleCloneMultiGroup

sampleCloneMultiGroup Down-sample clone to specified size with one o...

sampleClones

sampleClones Down-sample clones to specified size

scaleBranches

Scale branch lengths to represent either mutations or mutations per si...

stitchRegions

stitchRegions Similar to stitchVDJ but with segment IDs instead of nuc...

stitchVDJ

stitchVDJ combines germline gene segments to a single string

stopCodonCheck

Check whether sequences have in-frame premature stop codons (PTCs)

testPS

Performs PS (parsimony score) test on switch data

testSC

Performs SC (switch count) test on switch data

testSP

Performs SP (switch proportion) test on switch data

treesToPDF

Simple function for plotting a lot of trees into a pdf

write_clone_to_xml

Takes an airr clone object and template and writes a BEAST2 XML file

write_clones_to_xmls

Wrapper to write multiple clones to XML files

writeCloneSequences

Write the sequences used in tree building to a fasta format. If there ...

writeLineageFile

Write lineage file for IgPhyML use

Provides a set of functions for inferring, visualizing, and analyzing B cell phylogenetic trees. Provides methods to 1) reconstruct unmutated ancestral sequences, 2) build B cell phylogenetic trees using multiple methods, 3) visualize trees with metadata at the tips, 4) reconstruct intermediate sequences, 5) detect biased ancestor-descendant relationships among metadata types Workflow examples available at documentation site (see URL). Citations: Hoehn et al (2022) <doi:10.1371/journal.pcbi.1009885>, Hoehn et al (2021) <doi:10.1101/2021.01.06.425648>.

  • Maintainer: Kenneth Hoehn
  • License: AGPL-3
  • Last published: 2025-10-14