Skip to content

Commit

Permalink
addressing Aline's comments cont'd
Browse files Browse the repository at this point in the history
  • Loading branch information
hariszaf committed Sep 1, 2024
1 parent b9bd3ad commit 70e1568
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/mgg_tutorials/mgg_totorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ Then, as you will see in the following two cases, you will have to set the value

|Parameter | Variable | Description | Value |
|----------|---------------|-----------------------------------|-------|
|Choose input type |`input_category`| In case you already have a network, set it as `network` and load it; otherwise set it as `abundance_table`. In both cases you need to provide the abundance table though| `abundance_table` | `network` |
|Choose taxonomy database| `taxonomy` | In case a user's taxonomy is to be used, denotes which taxonomy scheme to be used from microbetag | [`GTDB` \| `dada2` \| `qiime2`]
|Choose input type |`input_category`| In case you already have a network, set it as `network` and load it; otherwise set it as `abundance_table`. In both cases you need to provide the abundance table though| [`abundance_table` \| `network`] |
|Choose taxonomy database| `taxonomy` | In case a user's taxonomy is to be used, denotes which taxonomy scheme to be used from microbetag | [`GTDB` \| `dada2` \| `qiime2`] |
|phenDB annotations | `phenDB` | return phenotypic traits based on phen models | bool |
|FAPROTAX annotations | `faprotax` | return annotations using the FAPROTAX database | bool |
|Pathway Complementarity | `pathway_complement`| return pathway complementarities between associated nodes | bool |
Expand Down
23 changes: 14 additions & 9 deletions docs/mgg_tutorials/roaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,16 @@ description: "tutorial on how to parse the annotated network using the MGG app"
1. TOC
{:toc}

--
---


{: .important-title}
> INPUT FILES USED IN THIS TUTORIAL
>
> We will use the `microbetag`-annogated network of the [network-based example-case](./from_net.md); you can get directly its corresponding `microbetag` - annotated network from [here][1].
Once an annotated network is returned (or [loaded](../tutorials/load.md)) on your Cytoscape main panel, you have all Cytoscape features (e.g., annotation, filtering, selecting etc.) plus those coming from the microbetag App facilitating a user-friendly way to go through the annotations returned.

Once an annotated network is returned (or [loaded](../tutorials/load.md)), you have all Cytoscape features (e.g., annotation, filtering, selecting etc.) plus those coming from the microbetag App facilitating a user-friendly way to go through the annotations returned.
We will use the `microbetag`-annogated network of the
[last example-case](./from_net.md).

Color-coding of the nodes (taxa) denoted the taxonomic level that a certain sequence was able to be mapped on *microbetag*.

Expand Down Expand Up @@ -59,8 +63,6 @@ By clicking on the *Show Species* button, all nodes that were not mapped to a ge
![show_species](../../assets/images/app/showSpecies.png)




Or you can choose/click directly any node on the network and check the `Nodes` Panel

![selcted_node](../../assets/images/app/nodePanel.png)
Expand All @@ -71,6 +73,10 @@ or several at the same time
![selcted_nodes](../../assets/images/app/nodePanelMultiNodes.png)


For more about how the PhenDB-like traits are assigned in each node you may have a look [here](../modules/modules.md#based-on-phendb) and for a thorough list of all the traits supported, you may check the corresponding [table](../modules/phen-traits.md).
In addition, for the FAPROTAX-based annotations, you may have a look [here](../modules/modules.md#based-on-faprotax) for how it works, and you can go through the whole list of potential traits supported in this [table](../modules/faprotax-functions.md).


### Filter for traits

You may select among a list of annotations under the `PhenDb/FAPROTAX filters` with `AND` and `OR` relationships.
Expand All @@ -95,8 +101,7 @@ Now, you can click on the **Edges** button on the bottom of the MGG panel to *ju

### Potential pathway complementarities

By clinking on a potential metabolic interaction edge, the donor and the beneficiary species, along with their corresponding sequence identifiers will be displayed
highlighting who potentially benefits from the other.
By clicking on a potential metabolic interaction edge, the donor and the beneficiary species, along with their corresponding sequence identifiers will be displayed.

Then, for cases where pathway complementarities have been returned for this association, a panel will be available for each pair of genomes that were mapped to those two taxa.
For each pair of genomes, a list with the potential metabolic complementarities is then returned.
Expand Down Expand Up @@ -129,4 +134,4 @@ Also, a new column provides the ModelSEED compound id that was actually found as
![kegg_seed_map](../../assets/images/app/seedKeggMap.png)



[1]:{{ site.url }}/microbetag/download/mgg/hessler_microbetag_network.cx
10 changes: 6 additions & 4 deletions docs/tutorials/prep.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ v1.0.1
> we will use the following 2 files:
>
> - the [`seq_ab_tab.tsv`][1] as our abundance table, which in its last column instead of a taxonomy includes the **ASV sequence**
> - [`config.yml`][2] required for the `microbetag_prep` to run
> - the [`config.yml`][2] where you may set your arguments for how to run the `microbetag_prep` image

## The *preparation* step
Expand Down Expand Up @@ -207,13 +207,15 @@ Assuming you downloaded the data from the link above in your `Downloads`:
mv ~/Downloads/seq_ab_tab.tsv my_microbetag_prep/
```

Now, you need to get the [`config.yml`][2] file and move it or keep a copy of it in the `my_microbetag_prep` folder.
<!-- If you have already downloaded this then you need to move/copy it in the `my_microbetag_prep` folder too.
Now, you need to get the `config.yml` file and move it or keep a copy of it in the `my_microbetag_prep` folder.
<!--
If you have already downloaded this then you need to move/copy it in the `my_microbetag_prep` folder too.
If you have not, then you may run
```bash
cd my_microbetag_prep # to move into your folder
wget https://raw.githubusercontent.com/hariszaf/microbetag/preprocess/test/config.yml
``` -->
```
-->

Your `my_microbetag_prep` folder should now look like:

Expand Down
1 change: 1 addition & 0 deletions download/mgg/hessler_microbetag_network.cx

Large diffs are not rendered by default.

0 comments on commit 70e1568

Please sign in to comment.