Mercurial > repos > galaxyp > mt2mq

annotate READme.md @ 5:c3a418f7cf7f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 499df83651e020e9106d70ec658edf86355f49d9"
author galaxyp
date Wed, 21 Oct 2020 16:39:25 +0000
parents b0de3731dca5
children 02fcbaf4cce5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
1 MT2MQ
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
2 ==========================================
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
3
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
4 Description
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
5 -----------
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
6
5
c3a418f7cf7f "planemo upload commit 499df83651e020e9106d70ec658edf86355f49d9"
galaxyp
parents: 4
diff changeset
7 In order to enable multi-omics data analysis of microbiome data, the Galaxy-P team has developed a tool – MT2MQ – which processes metatranscriptomics gene families output from [ASaiM](https://training.galaxyproject.org/training-material/topics/metagenomics/tutorials/metatranscriptomics/tutorial.html) workflow and converts it to [Gene Ontology](http://geneontology.org/docs/ontology-documentation/) (GO) or EC terms. The processed metatranscriptomics output can be subsequently used as an input for comparative statistical analysis via [metaQuantome](https://www.mcponline.org/content/18/8_suppl_1/S82) software suite.
3
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
8
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
9 Authors
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
10 -------
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
11
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
12 Authors and contributors:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
13
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
14 * Marie Crane
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
15 * Praveen Kumar
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
16 * Subina Mehta
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
17 * Dihn Duy An Nguyen
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
18 * Pratik Jagtap
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
19
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
20
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
21 # Instructions to run MT2MQ:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
22 --------------------------
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
23
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
24 The ASAIM workflow can be run following the training module on the [GTN](https://training.galaxyproject.org/training-material/topics/metagenomics/tutorials/metatranscriptomics/tutorial.html).
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
25 However, for training purposes we have provided inputs in the [test data](https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mt2mq/test-data).
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
26
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
27 ## Data upload
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
28
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
29 - Upload the files mentioned below to the Galaxy Europe instance.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
30 ```
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
31 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T4A.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
32 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T4B.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
33 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T4C.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
34 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T7A.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
35 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T7B.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
36 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T7C.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
37 https://github.com/galaxyproteomics/tools-galaxyp/blob/master/tools/mt2mq/test-data/T4T7_func.tsv
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
38
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
39 ```
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
40
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
41 ## Functional mode:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
42
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
43 1. Build a **Dataset list** for the six .tsv files( `T4A`,`T4B`,`T4C`,`T7A`,`T7B`,`T7C`).
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
44 - Click the **Operations on multiple datasets** check box at the top of the history panel.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
45 - Select the files mentioned above.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
46 - Click on ** For all selected** drop down menu and select **Build Dataset list**.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
47 - Once the collection is created, rename the dataset collection as `Input collection`.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
48
5
c3a418f7cf7f "planemo upload commit 499df83651e020e9106d70ec658edf86355f49d9"
galaxyp
parents: 4
diff changeset
49 2. Download the map_go_uniref50.txt file from [zenodo](https://doi.org/10.5281/zenodo.4115871).
3
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
50
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
51 3. Run the **Regroup a HUMAnN2 generated table by features**(Galaxy Version 0.11.1.0) tool is regrouping table features (abundances or coverage) given a table of feature values and a mapping of groups to component features. It produces a new table with group values in place of feature values.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
52 - [**Regroup a HUMAnN2 generated table by features**](https://toolshed.g2.bx.psu.edu/repository?repository_id=85391b8d5d7ad39d) with the following parameters:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
53
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
54 - *"Gene/pathway table"*: `Input collection`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
55 - *"How to combine grouped features?"*: `Sum`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
56 - In *"Use built-in grouping options?"*: `No`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
57 - *"Custom groups file"*: `map_go_uniref50.txt`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
58 - *"Is the groups file reversed?"*: `No`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
59 - *"Decimal places to round to after applying function"*: `3`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
60 - *"Include an 'UNGROUPED' group to capture features that did not belong to other groups?"*: `Yes`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
61 - *"Carry through protected features, such as 'UNMAPPED'?"*: `Yes`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
62
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
63 Once this tool is run, rename the dataset collection as `Regrouped collection` .
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
64
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
65 4. Run the **Rename features of a HUMAnN2 generated table** (Galaxy Version 0.11.1.0)tool to change the Uniref-50 values to GO term .
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
66 - [**Rename features of a HUMAnN2 generated table**](https://toolshed.g2.bx.psu.edu/repository?repository_id=c68108109505c2f5) with the following parameters:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
67
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
68 - *"Gene/pathway table"*: `Regrouped collection`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
69 - *"Type of renaming"*: `Standard renaming`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
70 - *"Table features that can be renamed?"*: `Gene Ontology (GO)`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
71 - *"Remove non-alphanumeric characters from names?"*: `No`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
72
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
73 Once this tool is run, rename the dataset collection as `Renamed collection`.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
74
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
75
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
76 5. Run the **Join HUMAnN2 generated tables** (Galaxy Version 0.11.1.1) tool to merge all the files into one.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
77 - [**Join HUMAnN2 generated tables**](https://toolshed.g2.bx.psu.edu/repository?repository_id=9b27f096128b26ff) with the following parameters:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
78
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
79 - *"Gene/pathway table"*: `Renamed collection`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
80
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
81 Once this tool is run, rename the dataset collection as `Joined Data`.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
82
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
83 6. Run the **Renormalize a HUMAnN2 generated table** (Galaxy Version 0.11.1.0) tool to normalize the data.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
84 - [**Renormalize a HUMAnN2 generated table**](https://toolshed.g2.bx.psu.edu/repository?repository_id=05a56fcdeac2a25c) with the following parameters:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
85
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
86 - *"Gene/pathway table"*: `Joined Data`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
87 - *"Normalization scheme"*: `Copies per million`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
88 - *"Normalization level"*: `Normalization of all levels by community total`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
89 - *"Include the special features UNMAPPED, UNINTEGRATED, and UNGROUPED?"*: `Yes`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
90 - *"Update '-RPK' in sample names to appropriate suffix?"*: `No`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
91
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
92 Once this tool is run, rename the dataset collection as `Renormalized data`.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
93
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
94
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
95 7. Now that the data is ready, we can run **MT2MQ Tool to prepare metatranscriptomic outputs from ASaiM for Metaquantome** (Galaxy Version 1.1.0)on this data.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
96 - [**MT2MQ Tool to prepare metatranscriptomic outputs from ASaiM for Metaquantome**](https://toolshed.g2.bx.psu.edu/repository?repository_id=cab5d81c5f0a2f94) with the
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
97 following parameters:
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
98 - *"Mode"*: `Function`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
99 - *"GO namespace"*: `Molecular Function` or `Biological Process` or ` Cellular Component`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
100 - *"File from HUMAnN2 after regrouping, renaming, joining, and renormalizing"*: `Renormalized data`
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
101
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
102 **Note** : The MT2MQ tools can be run will all three GO name space.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
103
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
104 There are two tabular outputs from this tool.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
105
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
106 - A f_int.tabular output which mimics the Intensity input file for metaQuantome.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
107 - A func.tabular output which mimics the Functional input file for metaQuantome.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
108
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
109 The resulting output files can be used as input for metaQuatome's functional mode.
08dda0f86758 "planemo upload commit 98f9787ed5158179a5baf54cea3dbe70a02aaf59"
galaxyp
parents:
diff changeset
110 To run metaQuantome Function mode. Follow the [GTN](https://github.com/subinamehta/training-material/tree/metaquantome-2-3/topics/proteomics/tutorials/metaquantome-function).