Introduction - dowser (original) (raw)

**IMPORTANT!**Dowser’s source code has moved to https://github.com/immcantation/dowser

To update Git configuration settings use:

   git config user.email "your-gh-user@email.com"
   git config user.name "your-gh-user-name"
   git remote set-url origin git@github.com:immcantation/dowser.git

Dowser is part of the Immcantationanalysis 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?

Documentation and tutorials

Full documention, including tutorials and vignettes: https://dowser.readthedocs.io

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

Dependencies

Depends: ggplot2
Imports: airr, alakazam, ape, Biostrings, dplyr, ggtree, graphics, gridExtra, markdown, methods, phangorn, phylotate, RColorBrewer, rlang, shazam, stats, stringr, tidyselect, tidyr, utils
Suggests: knitr, rmarkdown, testthat, pwalign

Kenneth Hoehn (aut, cre)
Cole Jensen (aut)
Susanna Marquez (ctb)
Jason Vander Heiden (ctb)
Steven Kleinstein (aut, cph)

Citing

To cite the dowser package in publications, please use

Hoehn K, Pybus O, Kleinstein S (2022). “Phylogenetic analysis of migration, differentiation, and class switching in B cells.” PLoS Computational Biology. doi:10.1371/journal.pcbi.1009885https://doi.org/10.1371/journal.pcbi.1009885,https://doi.org/10.1371/journal.pcbi.1009885.

If you use the correlationTestfunction for measurable evolution, please also cite

Hoehn K, Turner J, Miller F, Jiang R, Ellebedy A, Pybus O, Kleinstein S (2021). “Human B cell lineages associated with germinal centers following influenza vaccination are measurably evolving.” eLife. doi:10.7554/eLife.70873 https://doi.org/10.7554/eLife.70873,https://elifesciences.org/articles/70873.

If you construct paired heavy and light chain trees, please also cite

Jensen C, Sumner J, Kleinstein S, Hoehn K (2024). “Inferring B Cell Phylogenies from Paired H and L Chain BCR Sequences with Dowser.”The Journal of Immunology. doi:10.4049/jimmunol.2300851https://doi.org/10.4049/jimmunol.2300851,https://doi.org/10.4049/jimmunol.2300851.

If you additionally use IgPhyML for building trees please also cite

Hoehn K, Van der Heiden J, Zhou J, Lunter G, Pybus O, Kleinstein S (2019). “Repertoire-wide phylogenetic models of B cell molecular evolution reveal evolutionary signatures of aging and vaccination.”PNAS. doi:10.1073/pnas.1906020116https://doi.org/10.1073/pnas.1906020116,https://doi.org/10.1073/pnas.1906020116.

License

AGPL-3