annotate ras_generator.xml @ 86:b6af3f72fd28 draft

Uploaded
author bimib
date Mon, 07 Jun 2021 14:13:57 +0000
parents 035ba1736d38
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
85
035ba1736d38 Uploaded
bimib
parents:
diff changeset
1 <tool id="MaREA RAS Generator" name="Expression2RAS" version="1.0.7">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
2 <description>- Reaction Activity Scores computation</description>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
3 <macros>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
4 <import>marea_macros.xml</import>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
5 </macros>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
6 <requirements>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
7 <requirement type="package" version="0.25.3">pandas</requirement>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
8 <requirement type="package" version="1.6.3">scipy</requirement>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
9 <requirement type="package" version="4.6.3">lxml</requirement>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
10 <requirement type="package" version="1.1.0">svglib</requirement>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
11 <requirement type="package" version="3.5.67">reportlab</requirement>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
12 </requirements>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
13 <command detect_errors="exit_code">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
14 <![CDATA[
035ba1736d38 Uploaded
bimib
parents:
diff changeset
15 python $__tool_directory__/ras_generator.py
035ba1736d38 Uploaded
bimib
parents:
diff changeset
16 --rules_selector $cond_rule.rules_selector
035ba1736d38 Uploaded
bimib
parents:
diff changeset
17 --input $input
035ba1736d38 Uploaded
bimib
parents:
diff changeset
18 --none $none
035ba1736d38 Uploaded
bimib
parents:
diff changeset
19 --tool_dir $__tool_directory__
035ba1736d38 Uploaded
bimib
parents:
diff changeset
20 --out_log $log
035ba1736d38 Uploaded
bimib
parents:
diff changeset
21 --ras_output $ras_output
035ba1736d38 Uploaded
bimib
parents:
diff changeset
22 #if $cond_rule.rules_selector == 'Custom'
035ba1736d38 Uploaded
bimib
parents:
diff changeset
23 --custom $cond_rule.Custom_rules
035ba1736d38 Uploaded
bimib
parents:
diff changeset
24 #end if
035ba1736d38 Uploaded
bimib
parents:
diff changeset
25 ]]>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
26 </command>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
27 <inputs>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
28 <conditional name="cond_rule">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
29 <expand macro="options"/>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
30 <when value="HMRcore">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
31 </when>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
32 <when value="Recon">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
33 </when>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
34 <when value="Custom">
035ba1736d38 Uploaded
bimib
parents:
diff changeset
35 <param name="Custom_rules" type="data" format="tabular, csv, tsv, xml" label="Custom rules" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
36 </when>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
37 </conditional>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
38 <param name="input" argument="--input" type="data" format="tabular, csv, tsv" label="Gene Expression dataset:" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
39 <param name="name" argument="--name" type="text" label="Dataset's name:" value="Dataset" help="Default: Dataset" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
40 <param name="none" argument="--none" type="boolean" truevalue="true" falsevalue="false" checked="true" label="(A and NaN) solved as (A)?" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
41 </inputs>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
42
035ba1736d38 Uploaded
bimib
parents:
diff changeset
43 <outputs>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
44 <data format="txt" name="log" label="Expression2RAS - $name - Log" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
45 <data format="tabular" name="ras_output" label="$name RAS"/>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
46 </outputs>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
47
035ba1736d38 Uploaded
bimib
parents:
diff changeset
48 <help>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
49 <![CDATA[
035ba1736d38 Uploaded
bimib
parents:
diff changeset
50
035ba1736d38 Uploaded
bimib
parents:
diff changeset
51 What it does
035ba1736d38 Uploaded
bimib
parents:
diff changeset
52 -------------
035ba1736d38 Uploaded
bimib
parents:
diff changeset
53
035ba1736d38 Uploaded
bimib
parents:
diff changeset
54 This tool computes Reaction Activity Scores from gene expression (RNA-seq) dataset(s), as described in Graudenzi et al. Integration of transcriptomic data and metabolic networks in cancer samples reveals highly significant prognostic power. Journal of Biomedical Informatics, 2018, 87: 37-49.
035ba1736d38 Uploaded
bimib
parents:
diff changeset
55
035ba1736d38 Uploaded
bimib
parents:
diff changeset
56 Accepted files:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
57 - A gene expression dataset
035ba1736d38 Uploaded
bimib
parents:
diff changeset
58
035ba1736d38 Uploaded
bimib
parents:
diff changeset
59 Format:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
60 Tab-separated text file reporting the normalized expression level (e.g., TPM, RPKM, ...) of each gene (row) for a given sample (column).
035ba1736d38 Uploaded
bimib
parents:
diff changeset
61 Column header: sample ID.
035ba1736d38 Uploaded
bimib
parents:
diff changeset
62 Row header: gene ID.
035ba1736d38 Uploaded
bimib
parents:
diff changeset
63
035ba1736d38 Uploaded
bimib
parents:
diff changeset
64
035ba1736d38 Uploaded
bimib
parents:
diff changeset
65 Optional files:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
66 - custom GPR (Gene-Protein-Reaction) rules. Two accepted formats:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
67
035ba1736d38 Uploaded
bimib
parents:
diff changeset
68 * (Cobra Toolbox and CobraPy compliant) xml of metabolic model;
035ba1736d38 Uploaded
bimib
parents:
diff changeset
69 * .csv file specifyig for each reaction ID (column 1) the corresponding GPR rule (column 2).
035ba1736d38 Uploaded
bimib
parents:
diff changeset
70
035ba1736d38 Uploaded
bimib
parents:
diff changeset
71 Computation option ‘(A and NaN) solved as (A)’:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
72 In case of missing expression value, referred to as NaN (Not a Number), for a gene joined with an AND operator in a given GPR rule, the rule ‘A and NaN’
035ba1736d38 Uploaded
bimib
parents:
diff changeset
73
035ba1736d38 Uploaded
bimib
parents:
diff changeset
74 If YES is selected: the GPR will be solved as A.
035ba1736d38 Uploaded
bimib
parents:
diff changeset
75
035ba1736d38 Uploaded
bimib
parents:
diff changeset
76 If NO is selected: the GPR will be disregarded tout-court (i.e., treated as NaN).
035ba1736d38 Uploaded
bimib
parents:
diff changeset
77
035ba1736d38 Uploaded
bimib
parents:
diff changeset
78 Example input
035ba1736d38 Uploaded
bimib
parents:
diff changeset
79 -------------
035ba1736d38 Uploaded
bimib
parents:
diff changeset
80
035ba1736d38 Uploaded
bimib
parents:
diff changeset
81 Custom GPR rules:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
82
035ba1736d38 Uploaded
bimib
parents:
diff changeset
83 +------------+--------------------------------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
84 | id | rule (with entrez-id |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
85 +============+======================================+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
86 | r1642 | 155060 or 10357 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
87 +------------+--------------------------------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
88 | r1643 | 155060 or 100134869 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
89 +------------+--------------------------------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
90 | r1640 | 155060 and 100134869 or 10357 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
91 +------------+--------------------------------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
92
035ba1736d38 Uploaded
bimib
parents:
diff changeset
93 RNA-seq dataset:
035ba1736d38 Uploaded
bimib
parents:
diff changeset
94
035ba1736d38 Uploaded
bimib
parents:
diff changeset
95 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
96 | Hugo_ID | TCGAA62670 | TCGAA62671 | TCGAA62672 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
97 +============+================+================+================+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
98 | HGNC:24086 | 0.523167 | 0.371355 | 0.925661 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
99 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
100 | HGNC:24086 | 0.568765 | 0.765567 | 0.456789 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
101 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
102 | HGNC:9876 | 0.876545 | 0.768933 | 0.987654 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
103 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
104 | HGNC:9 | 0.456788 | 0.876543 | 0.876542 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
105 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
106 | HGNC:23 | 0.876543 | 0.786543 | 0.897654 |
035ba1736d38 Uploaded
bimib
parents:
diff changeset
107 +------------+----------------+----------------+----------------+
035ba1736d38 Uploaded
bimib
parents:
diff changeset
108
035ba1736d38 Uploaded
bimib
parents:
diff changeset
109 ]]>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
110 </help>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
111 <expand macro="citations" />
035ba1736d38 Uploaded
bimib
parents:
diff changeset
112 </tool>
035ba1736d38 Uploaded
bimib
parents:
diff changeset
113