Skip to main content

A qiime2 (https://qiime2.org/) plugin for dbBact (http://dbbact.org) annotations of microbiome experiments

Project description

# q2-dbbact A [Qiime2](https://qiime2.org/) plugin for [dbBact](http://dbbact.org)

![wordcloud](https://github.com/amnona/q2-dbbact/blob/main/pics/cfs-wordcloud.jpg) ![enriched barplot](https://github.com/amnona/q2-dbbact/blob/main/pics/enriched_terms.jpg) ![heatmap](https://github.com/amnona/q2-dbbact/blob/main/pics/heatmap.jpg)

# Features: * Differential abundance testing using [Calour](https://github.com/biocore/calour) rank-mean differential abundance test (with [dsFDR](https://escholarship.org/content/qt3j68q5n7/qt3j68q5n7_noSplash_e7ad1cf405f67b9cef0e5a99c1804fd5.pdf) correction). * dbBact term enrichment from differntial abundance results of qiime2 (i.e. songbird/q2-aldex2/ancom/dacomp or the built in rank-mean test). * Create a wordcloud of dbBact terms for a given feature table. * Generate an interactive heatmap visualization for a feature table. The heatmap provides links to dbBact annotations for each ASV. * Generate Venn diagram for a differential abundance result and a given dbBact term. * Background dbBact term enrichment analysis for experiments without controls (i.e. what terms are enriched in the bacteria in a given feature table compared to all dbBact experiments of a given type).

# Examples: ## Run the q2-dbBact enrichment pipeline for a given feature table: Our input is a feature table and a metadata file with a given column dividing our samples into two groups.

q2-dbBact will detect ASVs different between the two groups, and identify dbBact terms enriched in one of the two groups compared to the other

` qiime dbbact enrich-pipeline --i-table cfs-merged.qza --m-metadata-file map.cfs.txt --p-field Subject --output-dir cfs-pipeline`

## Draw an interactive heatmap This creates a zoomable heatmap with a list of dbBact annotation for each bacteria that is clicked. Useful for exploring your sequencing results and getting a feeling for what is going on (contaminations, bacterial sources, groups of samples, etc.)

Our input is a feature table and a metadata file with a given column dividing our samples into two groups.

`qiime dbbact heatmap --i-table cfs-table.qza --i-repseqs cfs-rep-seqs.qza --i-taxonomy cfs-taxonomy.qza --m-metadata-file map.cfs.txt --p-sort-field Subject --o-visualization heatmap-cfs`

![heatmap](https://github.com/amnona/q2-dbbact/blob/main/pics/heatmap.jpg)

## Draw a dbBact terms wordcloud for the set of bacteria in a feature-table The wordcloud is created for all the bacteria in the feature table.

The output wordcloud words are dbBact terms associated with the bacteria. The word size corresponds to the F-score (recall and precision) of the term. Blue terms are positively associated (i.e. appear in COMMON/DOMINANT/HIGHER IN annotations) where as red terms (preceeded by a “-”) are negatively associated (i.e. appear in LOWER IN annotations).

`qiime dbbact draw-wordcloud-vis --i-data cfs-table.qza --i-repseqs cfs-rep-seqs.qza --o-visualization wordcloud-cfs`

![wordcloud](https://github.com/amnona/q2-dbbact/blob/main/pics/cfs-wordcloud.jpg)

## Identify differentially abundant bacteria between two sample groups q2-dbBact utilizes the non-parametric (permutation based) Calour diff_abundance() function. By default it uses a rank-mean test with dsFDR multiple hypothesis correction.

The test can also be performed as a paired test using an additional metadata pair-field (permutations are performed only between samples sharing the same pair-field value).

`qiime dbbact diff-abundance --i-table cfs-merged.qza --m-metadata-file map.cfs.txt --p-field Subject --p-alpha 0.1 --p-val1 Patient --p-val2 Control --o-diff diff-cfs-dsfdr`

## Identify and plot enriched dbBact terms between two groups of bacteria Performed on the output of a differential-abundance test. q2-dbBact supports the following formats: * [songbird](https://github.com/biocore/songbird) * [ancom](https://github.com/qiime2/q2-composition) * [q2-aldex2](https://library.qiime2.org/plugins/q2-aldex2/24/) * dbBact diff-abundance * any tsv file

This command identifies dbBact terms the are significantly more associated with bacteria from one group compared to the other

`qiime dbbact enrichment --i-diff diff-cfs-dsfdr.qza --p-source dsfdr --o-enriched enriched-cfs-dsfdr`

The output can be visualized (and the complete table saved) using the visualization command:

`qiime dbbact plot-enrichment --i-enriched enriched-cfs-dsfdr.qza --o-visualization barplot-enriched-cfs-dsfdr --p-labels CFS Control`

![enriched barplot](https://github.com/amnona/q2-dbbact/blob/main/pics/enriched_terms.jpg)

## Venn diagram for examining term distribution in the two groups Input is the results of a differential abundance analysis (which provides two ASV groups - positive and negative effect size), and a dbBact term.

The venn diagram shows how many of the ASVs in each group have the term, as well as how many total dbBact ASVs have the term associated.

`qiime dbbact venn --i-diff diff-cfs-dsfdr.qza --p-terms "small village" --p-source dsfdr --p-label1 Control --p-label2 CFS --o-visualization venn-cfs-human-village`

![venn](https://github.com/amnona/q2-dbbact/blob/main/pics/venn-cfs-village.png)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

q2-dbbact-1.0.2.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

q2_dbbact-1.0.2-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file q2-dbbact-1.0.2.tar.gz.

File metadata

  • Download URL: q2-dbbact-1.0.2.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for q2-dbbact-1.0.2.tar.gz
Algorithm Hash digest
SHA256 51940765990e849933f5062e1cb4b0c3fd7d72d7314b3dd8bda6368ae686ce98
MD5 cccb64f5bd99134dfcd6a2f15c46c63a
BLAKE2b-256 cdcbf343626e7801f3973da69555aca631dde8760d865c6cbf49599f495f2dc2

See more details on using hashes here.

File details

Details for the file q2_dbbact-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: q2_dbbact-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for q2_dbbact-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 13a684afc47944c12ee9499c0e7149a3513cf2903b4596e2c12cd249f5b087cf
MD5 5ded92328e58ea8925a1edd46556e391
BLAKE2b-256 54ff1c4c0e06a396e23953f9da38070e410e5d8e7e2545e79ad1fef533509042

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page