Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #79

Merged
merged 3 commits into from
May 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ from 16S amplicon sequencing.
[FlashWeave](https://github.com/meringlab/FlashWeave.jl) is a
[Julia](https://julialang.org/) based package which predicts ecological
interactions between microbes from large-scale compositional abundance data
(i.e. OTU tables constructed from sequencing data) through statistical
(e.g., ASV or OTU tables constructed from sequencing data) through statistical
co-occurrence or co-abundance. It reports direct associations, with adjustment
for bystander effects and other confounders, and can furthermore integrate
environmental or technical factors into the analysis of microbial systems.
Expand Down Expand Up @@ -137,7 +137,6 @@ qiime tools import \
--type 'FeatureTable[Frequency]' \
--input-format BIOMV210Format \
--output-path sponge-feature-table.qza
# Imported Suberitida.biom as BIOMV210Format to spongeFeatureTable.qza
```
The QIIME 2 artefact ```spongeFeatureTable.qza``` should exist in the working
folder if this command was successful.
Expand All @@ -153,7 +152,6 @@ intended output artefact containing the inferred network.
qiime makarsa spiec-easi \
--i-table sponge-feature-table.qza \
--o-network sponge-net.qza
# Saved Network to: sponge-net.qza
```

From the ```sponge-net.qza``` network artefact a visualisation can be created
Expand All @@ -163,7 +161,7 @@ and then viewed
qiime makarsa visualise-network \
--i-network sponge-net.qza \
--o-visualization sponge-net.qzv
#Saved Visualization to: sponge-net.qzv

qiime tools view sponge-net.qzv
```

Expand Down Expand Up @@ -196,10 +194,11 @@ parameter switch and one of 3 keywords:
For example to infer the network from the example data using the MB method
execute the command

``` qiime makarsa spiec-easi \
--i-table spongeFeatureTable.qza \
--o-network sponge-net.qza \
--p-method mb
```
qiime makarsa spiec-easi \
--i-table spongeFeatureTable.qza \
--o-network sponge-net.qza \
--p-method mb
```

The remaining parameters relate to selection of the optimal penalty $\lambda$
Expand All @@ -225,18 +224,37 @@ similar. Create the network.
qiime makarsa flashweave \
--i-table sponge-feature-table.qza \
--o-network sponge-fw-net.qza
# Saved Network to: sponge-fw-net.qza
```
Then generate the visualisation.
```
qiime makarsa visualise-network \
--i-network sponge-fw-net.qza \
--o-visualization sponge-fw-net.qzv
#Saved Visualization to: sponge-fw-net.qzv
```
View the visualisation as usual
```
qiime tools view sponge-net.qzv
```

![fw-network](images/sponge-fw-network.png)

#### Modularity optimization

Once a network graph is generated, this can be used to identify modules of
co-occurring features. This is useful for, e.g., grouping these features
for downstream analyses. For module detection, q2-makarsa employs the
[Louvain method](https://doi.org/10.1088%2F1742-5468%2F2008%2F10%2FP10008).

```
qiime makarsa louvain-communities \
--i-network-input sponge-net.qza \
--o-community-out node-map.qza
```

You can view the resulting node map (showing which features belong to
each module):
```
qiime metadata tabulate \
--m-input-file node-map.qza \
--o-visualization node-map.qzv
```
Loading