annotate rps_generator.xml @ 289:f7812d713af5 draft default tip

Uploaded
author luca_milaz
date Tue, 09 Jul 2024 22:45:02 +0000
parents d385c4df70c3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
282
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="MaREA RPS Generator" name="Expression2RPS" version="1.0.0">
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
2 <description>- Reaction Propensity Scores computation</description>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
6 <requirements>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
7 <!--<requirement type="package" version="1.18.5">numpy</requirement>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
8 <requirement type="package" version="1.4.4">pandas</requirement>-->
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
9 <requirement type="package" version="4.6.3">lxml</requirement>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
10 </requirements>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
11 <command detect_errors="exit_code">
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
12 <![CDATA[
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
13 python $__tool_directory__/rps_generator.py
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
14 --input $input
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
15 --reaction_choice $cond_reactions.reaction_choice
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
16 --tool_dir $__tool_directory__
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
17 --out_log $log
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
18 --rps_output $rps_output
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
19 #if $cond_reactions.reaction_choice == 'custom'
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
20 --custom $cond_reactions.Custom_react
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
21 #end if
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
22 ]]>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
23 </command>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
24 <inputs>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
25 <param name="input" argument="--input" type="data" format="tabular, tsv, csv" label="Abundance dataset:" />
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
26 <param name="name" argument="--name" type="text" label="Dataset's name:" value="Dataset" help="Default: Dataset" />
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
27
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
28 <conditional name="cond_reactions">
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
29 <param name="reaction_choice" argument="--reaction_choice" type="select" label="Choose reaction dataset:">
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
30 <option value="default" selected="true">ENGRO2 reaction dataset </option>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
31 <option value="custom">Custom reaction dataset</option>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
32 </param>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
33 <when value="custom">
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
34 <param name="Custom_react" type="data" format="csv" label="Custom reactions" />
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
35 </when>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
36 </conditional>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
37 </inputs>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
38
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
39 <outputs>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
40 <data format="txt" name="log" label="Expression2RPS - $name - Log" />
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
41 <data format="tabular" name="rps_output" label="$name RPS"/>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
42 </outputs>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
43
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
44 <help>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
45 <![CDATA[
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
46
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
47 What it does
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
48 -------------
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
49
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
50 This tool computes Reaction Propensity Scores based on the availability of reaction substrates, for (ideally) each input model reaction and for each sample.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
51 The score is computed as the product of the concentrations of the reacting substances, with each concentration raised to a power equal to its stoichiometric coefficient. According to themass action law, the rate of any chemical reaction is indeed proportional to this product.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
52 This assumption holds as long as the substrate is in significant excess over the enzyme constant KM.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
53 If a metabolite is either missing in the model provided with respect to its reactions or it is present in our "black list", the RPS score is set to NaN.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
54 This "black list" of metabolites contains those substrates that are present in too many reactions to be significant. It is defined in the file black_list.pickle and cannot be modified by the user.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
55
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
56 Accepted files:
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
57 - An abundance dataset: Tab-separated text file reporting the abundance value of each metabolite for each cell line in the dataset.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
58 Column header: cell line ID.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
59 Row header: metabolite ID.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
60
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
61
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
62 Optional files:
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
63 - Custom reaction dataset: .csv file specifying for each reaction ID the corresponding formula.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
64 First column: reaction ID
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
65 Second column: reaction formula.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
66
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
67
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
68 Output:
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
69 -------------
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
70
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
71 The tool generates:
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
72 - a tab-separated file(.csv): reporting the RPS values for each reaction and each cell line in the dataset.
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
73 - a log file (.txt).
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
74 ]]>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
75 </help>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
76 <expand macro="citations" />
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
77 </tool>
d385c4df70c3 Uploaded
luca_milaz
parents:
diff changeset
78