annotate COBRAxy/ras_generator.xml @ 124:67a79e4f037a draft

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