annotate COBRAxy/rps_generator.xml @ 178:824b1ecc29db draft

Uploaded
author francesco_lapi
date Wed, 20 Nov 2024 14:59:42 +0000
parents 1226dedc2d7b
children 039362be6775
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 RPS Generator" name="Expression2RPS" version="2.0.0">
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
2 <description>- Reaction Propensity 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__/rps_generator.py
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
15 --input $input
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
16 --reaction_choice $cond_reactions.reaction_choice
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
17 --tool_dir $__tool_directory__
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
18 --out_log $log
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
19 --rps_output $rps_output
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
20 #if $cond_reactions.reaction_choice == 'custom'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
21 --custom $cond_reactions.Custom_react
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
22 #end if
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
23 ]]>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
24 </command>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
25 <inputs>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
26 <param name="input" argument="--input" type="data" format="tabular, tsv, csv" label="Abundance dataset:" />
137
1226dedc2d7b Uploaded
luca_milaz
parents: 4
diff changeset
27 <param name="name" argument="--name" type="text" label="Dataset's name:" value="Dataset_RPS" help="Default: Dataset_RPS. Do not use white spaces." />
4
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
28
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
29 <conditional name="cond_reactions">
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
30 <param name="reaction_choice" argument="--reaction_choice" type="select" label="Choose reaction dataset:">
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
31 <option value="default" selected="true">ENGRO2 reaction dataset </option>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
32 <option value="custom">Custom reaction dataset</option>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
33 </param>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
34 <when value="custom">
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
35 <param name="Custom_react" type="data" format="csv" label="Custom reactions" />
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
36 </when>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
37 </conditional>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
38 </inputs>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
39
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
40 <outputs>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
41 <data format="txt" name="log" label="Expression2RPS - $name - Log" />
137
1226dedc2d7b Uploaded
luca_milaz
parents: 4
diff changeset
42 <data format="tabular" name="rps_output" label="$name"/>
4
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
43 </outputs>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
44
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
45 <help>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
46 <![CDATA[
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
47
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
48 What it does
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
49 -------------
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
50
41f35c2f0c7b 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.
41f35c2f0c7b 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.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
53 This assumption holds as long as the substrate is in significant excess over the enzyme constant KM.
41f35c2f0c7b 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.
41f35c2f0c7b 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.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
56
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
57 Accepted files:
41f35c2f0c7b 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.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
59 Column header: cell line ID.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
60 Row header: metabolite ID.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
61
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
62
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
63 Optional files:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
64 - Custom reaction dataset: .csv file specifying for each reaction ID the corresponding formula.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
65 First column: reaction ID
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
66 Second column: reaction formula.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
67
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
68
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
69 Output:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
70 -------------
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
71
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
72 The tool generates:
41f35c2f0c7b 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.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
74 - a log file (.txt).
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
75 ]]>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
76 </help>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
77 <expand macro="citations" />
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
78 </tool>
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
79