annotate COBRAxy/ras_to_bounds.xml @ 96:e70a6363bb82 draft

Uploaded
author luca_milaz
date Sun, 13 Oct 2024 11:44:41 +0000
parents 45574f99a807
children a695435aa879
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
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
30 #if $cond_ras.ras_choice == "True"
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
31 --input_ras $cond_ras.input_ras
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
32 #end if
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
33 --out_log $log
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
34 ]]>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
35 </command>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
36 <inputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
37 <conditional name="cond_model">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
38 <expand macro="options_ras_to_bounds_model"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
39 <when value="Custom">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
40 <param name="model" argument="--model" type="data" format="json, xml" label="Custom model" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
41 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
42 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
43
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
44 <conditional name="cond_ras">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
45 <param name="ras_choice" argument="--ras_choice" type="select" label="Do want to use RAS?">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
46 <option value="True" selected="true">Yes</option>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
47 <option value="False">No</option>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
48 </param>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
49 <when value="True">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
50 <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
51 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
52 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
53
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
54 <conditional name="cond_medium">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
55 <expand macro="options_ras_to_bounds_medium"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
56 <when value="Custom">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
57 <param name="medium" argument="--medium" type="data" format="tabular, csv, tsv" label="Custom medium" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
58 </when>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
59 </conditional>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
60
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
61 </inputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
62
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
63 <outputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
64 <data format="txt" name="log" label="RAStoBounds- Log" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
65 <data format="tabular" name="cell_class" label="RAStoBounds - Cells class" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
66 <collection name="ras_to_bounds" type="list" label="Ras to Bounds">
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
67 <discover_datasets name = "collection" pattern="__name_and_ext__" directory="ras_to_bounds"/>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
68 </collection>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
69
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
70 </outputs>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
71
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
72 <help>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
73
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
74 <![CDATA[
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
75
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
76 What it does
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
77 -------------
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
78
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
79 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
80 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
81 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
82
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
83 Accepted files:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
84 - A model: JSON or XML file reporting reactions and rules contained in the model.
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
85 - 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
86 - Medium: tab-separated file containing lower and upper-bounds of medium reactions.
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
87
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
88 Example of custum growth medium fileeeee:
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
89
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
90
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
91 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
92 | Reaction ID| lower_bound | upper_bound |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
93 +============+================+================+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
94 | r1 | 0.123167 | 0.371355 |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
95 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
96 | r2 | 0.268765 | 0.765567 |
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
97 +------------+----------------+----------------+
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
98
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
99
96
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
100 Example for multiple RAS matrices:
e70a6363bb82 Uploaded
luca_milaz
parents: 95
diff changeset
101 - 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
102 - 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
103 - 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
104
93
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
105 Output:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
106 -------------
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
107
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
108 The tool generates:
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
109 - 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
110 - 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
111 - a log file (.txt).
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
112 ]]>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
113 </help>
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
114 <expand macro="citations" />
7e703e546998 Uploaded
luca_milaz
parents:
diff changeset
115 </tool>