Skip to content

Commit

Permalink
DOC: readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ebolyen committed Apr 29, 2022
1 parent 9eaf9a0 commit 7097ef3
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
![](https://github.com/qiime2/q2-fmt/workflows/ci/badge.svg)

## Demo
![](https://raw.githubusercontent.com/qiime2/q2-fmt/master/demo/screenshot.png)
[** Interactive Link **](https://raw.githubusercontent.com/qiime2/q2-fmt/master/demo/raincloud-baseline0.qzv)
[![](https://raw.githubusercontent.com/qiime2/q2-fmt/master/demo/screenshot.png)
**Interactive Link**](https://view.qiime2.org/visualization/?type=html&src=https%3A%2F%2Fraw.githubusercontent.com%2Fqiime2%2Fq2-fmt%2Fmaster%2Fdemo%2Fraincloud-baseline0.qzv)

## Installation

Expand All @@ -28,6 +28,7 @@ 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.
```bash
Expand All @@ -49,6 +50,7 @@ qiime fmt engraftment \
---

**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
Expand All @@ -70,6 +72,7 @@ qiime fmt group-timepoints \
```

**Statistical Tests**

Wilcoxon Signed Rank tests and Mann-Whitney U tests are available and
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
Expand Down Expand Up @@ -97,6 +100,7 @@ qiime fmt wilcoxon-srt \
```

**Raincloud Plots**

A statistical test is not required to generate the plots, but if provided, will
produce a table showing the results of the test.
```bash
Expand Down

0 comments on commit 7097ef3

Please sign in to comment.