annotate COBRAxy/ras_to_bounds.xml @ 101:6cb85065b38b draft

Uploaded
author luca_milaz
date Sun, 13 Oct 2024 12:00:59 +0000
parents c7bdcfbb575c
children a78d83753cce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="MaREA RAS to bounds" name="RAStoBounds" version="2.0.0">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
2
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
6
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
7 <requirements>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
8 <requirement type="package" version="1.24.4">numpy</requirement>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
9 <requirement type="package" version="2.0.3">pandas</requirement>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
10 <requirement type="package" version="0.29.0">cobra</requirement>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
11 <requirement type="package" version="5.2.2">lxml</requirement>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
12 <requirement type="package" version="1.4.2">joblib</requirement>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
13 </requirements>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
14
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
15 <command detect_errors="exit_code">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
16 <![CDATA[
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
17 python $__tool_directory__/ras_to_bounds.py
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
18 --tool_dir $__tool_directory__
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
19 --model_selector $cond_model.model_selector
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
20 --cell_class $cell_class
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
21 #if $cond_model.model_selector == 'Custom'
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
22 --model $model
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
23 --model_name $model.element_identifier
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
24 #end if
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
25 --medium_selector $cond_medium.medium_selector
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
26 #if $cond_medium.medium_selector == 'Custom'
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
27 --medium $medium
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
28 #end if
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
29 --ras_selector $cond_ras.ras_choice
97
a695435aa879 Uploaded
luca_milaz
parents: 96
diff changeset
30 #set $names = ""
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
31 #if $cond_ras.ras_choice == "True"
100
c7bdcfbb575c Uploaded
luca_milaz
parents: 99
diff changeset
32 --input_ras "${",".join(map(str, $cond_ras.input_ras))}"
97
a695435aa879 Uploaded
luca_milaz
parents: 96
diff changeset
33 #for $input_temp in $cond_ras.input_ras:
100
c7bdcfbb575c Uploaded
luca_milaz
parents: 99
diff changeset
34 #set $names = $names + $input_temp.element_identifier + ","
97
a695435aa879 Uploaded
luca_milaz
parents: 96
diff changeset
35 #end for
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
36 #end if
101
6cb85065b38b Uploaded
luca_milaz
parents: 100
diff changeset
37 --name "$names"
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
38 --out_log $log
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
39 ]]>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
40 </command>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
41 <inputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
42 <conditional name="cond_model">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
43 <expand macro="options_ras_to_bounds_model"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
44 <when value="Custom">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
45 <param name="model" argument="--model" type="data" format="json, xml" label="Custom model" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
46 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
47 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
48
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
49 <conditional name="cond_ras">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
50 <param name="ras_choice" argument="--ras_choice" type="select" label="Do want to use RAS?">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
51 <option value="True" selected="true">Yes</option>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
52 <option value="False">No</option>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
53 </param>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
54 <when value="True">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
55 <param name="input_ras" argument="--input_ras" multiple="true" type="data" format="tabular, csv, tsv" label="RAS matrix:" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
56 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
57 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
58
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
59 <conditional name="cond_medium">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
60 <expand macro="options_ras_to_bounds_medium"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
61 <when value="Custom">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
62 <param name="medium" argument="--medium" type="data" format="tabular, csv, tsv" label="Custom medium" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
63 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
64 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
65
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
66 </inputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
67
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
68 <outputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
69 <data format="txt" name="log" label="RAStoBounds- Log" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
70 <data format="tabular" name="cell_class" label="RAStoBounds - Cells class" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
71 <collection name="ras_to_bounds" type="list" label="Ras to Bounds">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
72 <discover_datasets name = "collection" pattern="__name_and_ext__" directory="ras_to_bounds"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
73 </collection>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
74
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
75 </outputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
76
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
77 <help>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
78
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
79 <![CDATA[
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
80
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
81 What it does
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
82 -------------
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
83
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
84 This tool generates the reactions bounds for a given metabolic model (JSON or XML format) both with and without the use of the Reaction Activity Scores (RAS) matrix generated by RAS generator.
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
85 Moreover, it enables to use custom/pre-defined growth mediums to constrain exchange reactions. For a custom medium, It is suggested to use the template file returned by the Custom Data Generator tool.
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
86 If the RAS matrix, generated by the RAS generator tool, is used, then a bounds file is generated for each cell. Otherwise, a single bounds file is returned.
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
87
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
88 Accepted files:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
89 - A model: JSON or XML file reporting reactions and rules contained in the model.
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
90 - RAS matrix: tab-separated RAS file as returned by RAS generator. Multiple RAS files can be uploaded too (e.g. one RAS matrix for normal cells and one for cancer cells). Note that if multiple RAs matrices are uploaded, the bounds are normalzed across all cells.
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
91 - Medium: tab-separated file containing lower and upper-bounds of medium reactions.
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
92
99
9f1a751652fc Uploaded
luca_milaz
parents: 97
diff changeset
93 Example of custum growth medium file:
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
94
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
95
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
96 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
97 | Reaction ID| lower_bound | upper_bound |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
98 +============+================+================+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
99 | r1 | 0.123167 | 0.371355 |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
100 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
101 | r2 | 0.268765 | 0.765567 |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
102 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
103
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
104
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
105 Example for multiple RAS matrices:
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
106 - cancer.csv and normal.csv generated by RAS generator tool (the two class names are 'cancer' and 'normal').
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
107 - This tool returns one unique collection of bounds files for both cancer and normal cells (normalization is performed across all cells).
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
108 - The association cell-class is reported in the 'cell_class' file that is useful to perform flux enrichment analysis based on class partenrship.
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
109
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
110 Output:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
111 -------------
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
112
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
113 The tool generates:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
114 - bounds: reporting the bounds of the model, or cells if RAS is used. Format: tab-separated.
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
115 - Classes: a file containing the class of each cell (only if multiple RAS matrices were uploaded). The class name of a RAS matrix corresponds to its file name. Format: tab-separated.
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
116 - a log file (.txt).
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
117 ]]>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
118 </help>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
119 <expand macro="citations" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
120 </tool>