annotate cobraxy-9688ad27287b/COBRAxy/rps_generator.xml @ 90:a48b2e06ebe7 draft

Uploaded
author luca_milaz
date Sun, 13 Oct 2024 11:35:56 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
90
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="MaREA RPS Generator" name="Expression2RPS" version="2.0.0">
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
2 <description>- Reaction Propensity Scores computation</description>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
6 <requirements>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
7 <requirement type="package" version="1.24.4">numpy</requirement>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
8 <requirement type="package" version="2.0.3">pandas</requirement>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
9 <requirement type="package" version="5.2.2">lxml</requirement>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
10 <requirement type="package" version="0.29.0">cobra</requirement>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
11 </requirements>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
12 <command detect_errors="exit_code">
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
13 <![CDATA[
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
14 python $__tool_directory__/rps_generator.py
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
15 --input $input
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
16 --reaction_choice $cond_reactions.reaction_choice
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
17 --tool_dir $__tool_directory__
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
18 --out_log $log
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
19 --rps_output $rps_output
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
20 #if $cond_reactions.reaction_choice == 'custom'
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
21 --custom $cond_reactions.Custom_react
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
22 #end if
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
23 ]]>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
24 </command>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
25 <inputs>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
26 <param name="input" argument="--input" type="data" format="tabular, tsv, csv" label="Abundance dataset:" />
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
27 <param name="name" argument="--name" type="text" label="Dataset's name:" value="Dataset" help="Default: Dataset" />
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
28
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
29 <conditional name="cond_reactions">
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
30 <param name="reaction_choice" argument="--reaction_choice" type="select" label="Choose reaction dataset:">
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
31 <option value="default" selected="true">ENGRO2 reaction dataset </option>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
32 <option value="custom">Custom reaction dataset</option>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
33 </param>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
34 <when value="custom">
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
35 <param name="Custom_react" type="data" format="csv" label="Custom reactions" />
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
36 </when>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
37 </conditional>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
38 </inputs>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
39
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
40 <outputs>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
41 <data format="txt" name="log" label="Expression2RPS - $name - Log" />
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
42 <data format="tabular" name="rps_output" label="$name RPS"/>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
43 </outputs>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
44
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
45 <help>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
46 <![CDATA[
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
47
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
48 What it does
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
49 -------------
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
50
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
51 This tool computes Reaction Propensity Scores based on the availability of reaction substrates, for (ideally) each input model reaction and for each sample.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
52 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.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
53 This assumption holds as long as the substrate is in significant excess over the enzyme constant KM.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
54 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.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
55 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.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
56
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
57 Accepted files:
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
58 - An abundance dataset: Tab-separated text file reporting the abundance value of each metabolite for each cell line in the dataset.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
59 Column header: cell line ID.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
60 Row header: metabolite ID.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
61
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
62
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
63 Optional files:
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
64 - Custom reaction dataset: .csv file specifying for each reaction ID the corresponding formula.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
65 First column: reaction ID
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
66 Second column: reaction formula.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
67
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
68
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
69 Output:
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
70 -------------
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
71
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
72 The tool generates:
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
73 - a tab-separated file(.csv): reporting the RPS values for each reaction and each cell line in the dataset.
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
74 - a log file (.txt).
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
75 ]]>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
76 </help>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
77 <expand macro="citations" />
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
78 </tool>
a48b2e06ebe7 Uploaded
luca_milaz
parents:
diff changeset
79