GithubHelp home page GithubHelp logo

cherman2 / q2-fmt Goto Github PK

View Code? Open in Web Editor NEW

This project forked from qiime2/q2-fmt

0.0 0.0 0.0 987 KB

Plugin for analysing the efficacy of fecal microbiota transplants

License: BSD 3-Clause "New" or "Revised" License

Python 98.16% Makefile 0.12% HTML 0.61% TeX 1.11%

q2-fmt's Introduction

q2-fmt (fecal microbiota transplant)

Demo

Interactive Link

Installation

Please note that this software is now an alpha release. Initial conda packages are available, but have not been tested in integration against our other plugins yet. For now, create a fresh conda environment for q2-fmt using the following command:

Mac OS instructions

wget https://data.qiime2.org/distro/fmt/qiime2-fmt-2023.9-py38-osx-conda.yml
CONDA_SUBDIR=osx-64 conda env create -n qiime2-fmt-2023.9 --file qiime2-fmt-2023.9-py38-osx-conda.yml
conda activate qiime2-fmt-2023.9
conda config --env --set subdir osx-64

Linux instructions

wget https://data.qiime2.org/distro/fmt/qiime2-fmt-2023.9-py38-linux-conda.yml
conda env create -n qiime2-fmt-2023.9 --file qiime2-fmt-2023.9-py38-linux-conda.yml

Then activate your new environment as usual.

conda activate q2-fmt-2023.9

Please be aware that q2-fmt and q2-stats will be the only visible plugins in this environment.

Examples

Example data can be generated using the --example-data flag on each action described below. This will create a directory structure to match the examples (you will need to cd into the appropriate directory first).

qiime fmt --example-data fmt-examples/
cd fmt-examples/engraftment/engraftment-baseline/

Plot Engraftment

This pipeline will execute the below actions in order to produce engraftment plots in a single step. To learn more, see the examples below this.

qiime fmt engraftment \
  --i-diversity-measure div-measure.qza \
  --m-metadata-file md.tsv \
  --p-compare baseline \
  --p-time-column week \
  --p-reference-column InitialDonorSampleID \
  --p-subject-column SubjectID \
  --p-where '[SampleType]="stool"' \
  --p-filter-missing-references \
  --p-against-group 0 \
  --p-p-val-approx asymptotic \
  --o-stats stats.qza \
  --o-raincloud-plot raincloud-plot.qzv

Group Timepoints

First the data must be collected from your study and organized into groups with some relevant diversity measure. We will use Faith's Phylogenetic Diversity in these examples, but other measures, including beta diversity metrics, are supported.

This command will produce two collections of groups: one for subjects at each timepoint, and another for references/donors and any control groups.

qiime fmt group-timepoints \
  --i-diversity-measure div-measure.qza \
  --m-metadata-file md.tsv \
  --p-where '[SampleType]="stool"' \
  --p-time-column week \
  --p-reference-column InitialDonorSampleID \
  --p-subject-column SubjectID \
  --p-filter-missing-references \
  --o-timepoint-dists timepoint-dists.qza \
  --o-reference-dists reference-dists.qza

Statistical Tests

Wilcoxon Signed Rank tests and Mann-Whitney U tests are available through q2-stats and can be used for FMT analysis. These two tests are differentiated by the semantic type of the input to ensure the applicability of the test (i.e. only matched pairs for Wilcoxon, and independent groups for Mann-Whitney).

Comparisons for Wilcoxon Signed Rank:

  • baseline: Compare each timepoint against a reference timpoint
  • consecutive: Compare each timepoint against its next timepoint

Comparisons for Mann-Whitney U:

  • reference: Compare other groups against a particular reference group
  • all-pairwise: Compare all pairwise groups.

The against-each parameter is needed to compare the timepoints against the references/controls. The engraftment pipeline above does this automatically.

qiime stats wilcoxon-srt \
  --i-distribution timepoint-dists.qza \
  --p-compare baseline \
  --p-baseline-group 0 \
  --p-p-val-approx asymptotic \
  --o-stats stats_baseline0.qza

Raincloud Plots

Also available through q2-stats - a statistical test is not required to generate the plots, but if provided, will produce a table showing the results of the test.

qiime stats plot-rainclouds \
  --i-data timepoint-dists.qza \
  --i-stats stats_baseline0.qza \
  --o-visualization raincloud-baseline0.qzv

q2-fmt's People

Contributors

lizgehret avatar cherman2 avatar ebolyen avatar q2d2 avatar thermokarst avatar oddant1 avatar gregcaporaso avatar colinvwood avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.