diff --git a/Docs/MetaX_Cookbook.assets/taxa_func_link_bar.png b/Docs/MetaX_Cookbook.assets/taxa_func_link_bar.png index 41f5a35..e70aa74 100644 Binary files a/Docs/MetaX_Cookbook.assets/taxa_func_link_bar.png and b/Docs/MetaX_Cookbook.assets/taxa_func_link_bar.png differ diff --git a/Docs/MetaX_Cookbook.assets/taxa_func_link_heatmap.png b/Docs/MetaX_Cookbook.assets/taxa_func_link_heatmap.png index d76c54d..becf409 100644 Binary files a/Docs/MetaX_Cookbook.assets/taxa_func_link_heatmap.png and b/Docs/MetaX_Cookbook.assets/taxa_func_link_heatmap.png differ diff --git a/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_bar.png b/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_bar.png index aee5246..642d2c6 100644 Binary files a/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_bar.png and b/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_bar.png differ diff --git a/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_heatmap.png b/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_heatmap.png index 854436c..1d01f79 100644 Binary files a/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_heatmap.png and b/Docs/MetaX_Cookbook.assets/taxa_func_link_pep_heatmap.png differ diff --git a/Docs/MetaX_Cookbook.assets/tf_link_net.png b/Docs/MetaX_Cookbook.assets/tf_link_net.png index 1b6ce46..0c4eb8e 100644 Binary files a/Docs/MetaX_Cookbook.assets/tf_link_net.png and b/Docs/MetaX_Cookbook.assets/tf_link_net.png differ diff --git a/Docs/MetaX_Cookbook.md b/Docs/MetaX_Cookbook.md index 9f7b81d..a3591dc 100644 --- a/Docs/MetaX_Cookbook.md +++ b/Docs/MetaX_Cookbook.md @@ -608,15 +608,15 @@ We can select **meta** **groups** or **samples** (default a - Select some groups (Default all) to get **the intensity of each taxon of this function** - image-20230728152953911 + -image-20230728151451213 + - Plot **peptides** in one Function of a Taxon - taxa_func_link_pep_heatmap + - taxa_func_link_pep_bar + - Switch Bar to Stacked or not ( Line) diff --git a/README.md b/README.md index 87d80ec..d5d03d0 100644 --- a/README.md +++ b/README.md @@ -19,37 +19,51 @@ The Tools in OTF Analyzer ![compostion](https://github.com/byemaxx/MetaX/raw/main/Docs/MetaX_Cookbook.assets/composition.png) -## OTFs Network +## OTFs Examples -Linking Taxa and Functions in different levels of the hierarchy, and different functional categories. e.g., **Species-KO**, **Genus-CAZy**, **Phylum-EC**, etc. +Linking Taxa and Functions in different levels of the hierarchy, and various functional categories. e.g., **Species-KO**, **Genus-CAZy**, **Phylum-EC**, etc. Lots of visualization tools can be selected. -- ![OTF](https://github.com/byemaxx/MetaX/raw/main/Docs/MetaX_Cookbook.assets/tf_link_net.png) +**Network** +**Dots** represent taxa and **squares** represent functions in the network. +- OTF -e.g. The **KEGG Pathways** linked to ***Roseburia hominis*** -- ![tf_link_net_2](https://github.com/byemaxx/MetaX/raw/main/Docs/MetaX_Cookbook.assets/tf_link_net_2.png) +**Heatmap** +Show all Taxa of a function. -## Download -### `Desktop Version(Recommended)`: -The desktop version comes fully set up and ready to use, including all required dependencies and a graphical user interface. +- tf_link_heatmap -Download MetaX Desktop Version +**Bar** +Show all functions of a taxon + +- tf_link_bar + + + +## Download & Installation +- **Desktop Version** (Recommended) + + > The desktop version comes fully set up and ready to use, including all required dependencies and a graphical user interface. + > + > Download the MetaX Desktop Version
-### `Command-line version`: -Use [PyPi](https://pypi.org/project/MetaXTools/) to install, then type `metax` in the terminal to launch the GUI. - ```bash - python -m pip install MetaXTools - ``` +- **Command-line version** + > Use [PyPi](https://pypi.org/project/MetaXTools/) to install, then type `metax` in the terminal to launch the GUI. + > + > `python -m pip install MetaXTools` + + + +## Guidebook -## Getting Started - `Desktop Version(desktop)`: - Refer to the MetaX Cookbook for detailed instructions on how to use MetaX with the graphical user interface.
@@ -57,7 +71,8 @@ Use [PyPi](https://pypi.org/project/MetaXTools/) to install, then type `metax` i - Read the example documentation in the [Notebook](https://github.com/byemaxx/MetaX/blob/main/Docs/example.ipynb) for detailed instructions and examples. -## Citing MetaX -- If you use MetaX in your research, please cite the following publication: - - **MetaX: A peptide centric metaproteomic data analysis platform using Operational Taxa-Functions (OTF)**. *Wu, Q., Ning, Z., Zhang, A., Zhang, X., Sun, Z., & Figeys, D.* (2024). bioRxiv. DOI: 10.1101/2024.04.19.590315. +## Citing +If you use MetaX in your research, please cite the following publication: + +> **MetaX: A peptide centric metaproteomic data analysis platform using Operational Taxa-Functions (OTF)**. *Wu, Q., Ning, Z., Zhang, A., Zhang, X., Sun, Z., & Figeys, D.* (2024). bioRxiv. DOI: 10.1101/2024.04.19.590315.