annotate ras_generator.xml @ 289:f7812d713af5 draft default tip

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