Mercurial > repos > malex > gait_gm
annotate ensembl2symbol.xml @ 2:2c218a253d56 draft default tip
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
author | malex |
---|---|
date | Thu, 29 Jul 2021 20:48:10 +0000 |
parents | ec9ee8edb84d |
children |
rev | line source |
---|---|
1 | 1 <tool id="secimtools_ensembl2symbol" name="Map ENSEMBLIDs to Gene Symbols." version="@WRAPPER_VERSION@"> |
2 <description></description> | |
3 <macros> | |
4 <import>macros.xml</import> | |
5 </macros> | |
6 <expand macro="requirements" /> | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
7 <stdio> |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
8 <exit_code range="1" level="fatal" description="Repeated Unique IDs"/> |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
9 </stdio> |
1 | 10 <command detect_errors="exit_code"><![CDATA[ |
11 ensembl2symbol.py | |
12 -s=$species | |
13 -ga=$geneAnnot | |
14 -id=$uniqId | |
15 -e=$ensemblId | |
16 -o=$output | |
17 ]]></command> | |
18 <inputs> | |
19 <param name="species" type="select" label="Select the species your ENSEMBLIDs are from" > | |
20 <option value="human">Homo sapiens</option> | |
21 <option value="mouse">Mus musculus</option> | |
22 <option value="rat">Rattus norvegicus</option> | |
23 <option value="fruitfly">Drosophila melanogaster</option> | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
24 <option value="thale-cress">Arabidopsis thaliana</option> |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
25 <option value="nematode">Caenorhabditis elegans</option> |
1 | 26 </param> |
27 <param name="geneAnnot" type="data" format="tabular" label="Select the Dataset from your History containing the ENSEMBLIDs"/> | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
28 <param name="uniqId" type="text" size="30" value="" label="Unique Gene FeatureID" help="Name of the column in your dataset containing unique FeatureIDs."/> |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
29 <param name="ensemblId" type="text" size="30" value="" label="ENSEMBLID" help="Name of the column containing the ENSEMBLIDs to use for linking to gene symbols."/> |
1 | 30 </inputs> |
31 <outputs> | |
32 <data format="tabular" name="output" label="${tool.name} on ${on_string}: ENSEMBL to GeneSymbol Annotation File"/> | |
33 </outputs> | |
34 <tests> | |
35 <test> | |
36 <param name="species" value="rat"/> | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
37 <param name="geneAnnot" value="gene_annotation.tsv"/> |
1 | 38 <param name="uniqId" value="UniqueID"/> |
39 <param name="ensemblId" value="GeneName"/> | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
40 <output name="output" value="ensembl2symbol_annotation.tsv"/> |
1 | 41 </test> |
42 </tests> | |
43 <help><![CDATA[ | |
44 | |
45 **Tool Description** | |
46 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
47 This tool takes an annotation data file containing unique FeatureIDs and Ensembl IDs and adds |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
48 gene symbols. The link from the Ensembl IDs to gene symbols is made using mygene |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
49 (https://mygene.info/). The tool adds the following columns to the input annotation data file: |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
50 GeneSymbol, Score, Selected and Tie. |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
51 |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
52 The GeneSymbol column contains the short-form abbreviation for the gene. The Score column |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
53 contains a value generated by mygene indicating how well the Ensembl ID matched the returned gene |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
54 symbol(s) (https://genomebiology.biomedcentral.com/articles/10.1186/s13059-016-0953-9). For |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
55 cases where an Ensembl ID uniquely matches to a gene symbol, the Selected column = ‘Yes”. For |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
56 cases where an Ensembl ID matches to more than one gene symbol, the Selected column = ‘Yes’ for |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
57 the gene symbol with the best Score value. If there is a tie, the alphabetically first gene |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
58 symbol is selected and the Tie column = ‘Yes’. We note that FeatureID may not be unique in the |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
59 resulting output dataset. |
1 | 60 |
61 -------------------------------------------------------------------------------- | |
62 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
63 **Input** |
1 | 64 |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
65 **Dataset with unique FeatureID and ENSEMBLID values** |
1 | 66 |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
67 +-------------+--------------+-----+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
68 | FeatureID | ENSEMBLID | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
69 +=============+==============+=====+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
70 | FeatureID_1 | ENS... | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
71 +-------------+--------------+-----+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
72 | FeatureID_2 | ENS... | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
73 +-------------+--------------+-----+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
74 | FeatureID_3 | ENS... | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
75 +-------------+--------------+-----+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
76 | ... | ... | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
77 +-------------+--------------+-----+ |
1 | 78 |
79 **NOTE:** This file must contain at least two columns, a column with unique FeatureIDs and a column containing ENSEMBLIDs. Other columns may be present. | |
80 | |
81 **Unique FeatureID** | |
82 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
83 Name of the column in your input dataset that has unique FeatureIDs. |
1 | 84 |
85 **ENSEMBLID** | |
86 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
87 Name of the column containing the ENSEMBLIDs. |
1 | 88 |
89 -------------------------------------------------------------------------------- | |
90 | |
91 **OUTPUT** | |
92 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
93 The user will get a single output file containing the linked gene symbols. |
1 | 94 |
95 **Output Table** | |
96 | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
97 +-------------+------------+--------------+-------------+-----------+----------+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
98 | FeatureID | ENSEMBLID | ... | GeneSymbol | Score | Selected | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
99 +=============+============+==============+=============+===========+==========+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
100 | FeatureID_1 | ENS... | ... | one* | 13.550056 | Yes | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
101 +-------------+------------+--------------+-------------+-----------+----------+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
102 | FeatureID_2 | ENS... | ... | two* | 12.984067 | Yes | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
103 +-------------+------------+--------------+-------------+-----------+----------+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
104 | FeatureID_2 | ENS... | ... | three* | 11.995048 | No | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
105 +-------------+------------+--------------+-------------+-----------+----------+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
106 | FeatureID_3 | ENS... | ... | four* | 12.549084 | Yes | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
107 +-------------+------------+--------------+-------------+-----------+----------+ |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
108 | ... | ... | ... | ... | ... | ... | |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
109 +-------------+------------+--------------+-------------+-----------+----------+ |
1 | 110 |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
111 '*'=refers to the matched gene |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
112 |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
113 ]]></help> |
1 | 114 <citations> |
115 <citation type="bibtex">@ARTICLE{Kirpich17secimtools, | |
116 author = {Alexander S. Kirpich, Miguel Ibarra, Oleksandr Moskalenko, Justin M. Fear, Joseph Gerken, Xinlei Mi, Ali Ashrafi, Alison M. Morse, Lauren M. McIntyre}, | |
117 title = {SECIMTools: A suite of Metabolomics Data Analysis Tools}, | |
118 journal = {BMC Bioinformatics}, | |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
119 year = {2018} |
1 | 120 }</citation> |
2
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
121 <citation type="bibtex">@article{Mor2021GaitGM, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
122 title={GAIT-GM integrative cross-omics analyses reveal cholinergic defects in a C. elegans model of Parkinson's disease}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
123 author={Mor, DE and Huertas, F and Morse, AM and Kaletsky, R and Murphy, CT and Kalia, V and Miller, GW and Moskalenko, O and Conesa, A and McIntyre, LM}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
124 journal={BMC Genomics}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
125 year={submitted}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
126 }</citation> |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
127 <citation type="bibtex">@article{xim2016mygene, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
128 title={High-performance web services for querying gene and variant annotation}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
129 author={Xin, J and Mark, A and Afrashiabi, C and Tsueng, G and Juchler, M and Gopal, N and Stupp, GS and Putman, TE and Ainscough, BJ and Griffith, OL and Torkamani, A and Whetzel, PL and Mungall, CJ and Mooney, SD and Su, AI and Wu, C}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
130 journal={Genome Biology}, |
2c218a253d56
"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents:
1
diff
changeset
|
131 year={2016}, |
1 | 132 }</citation> |
133 </citations> | |
134 </tool> |