annotate COBRAxy/ras_to_bounds.xml @ 88:c5820d87b4a5 draft

Uploaded
author luca_milaz
date Sun, 13 Oct 2024 11:33:51 +0000
parents 9c802c5cad40
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="MaREA RAS to bounds" name="RAStoBounds" version="2.0.0">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
2
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
6
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
7 <requirements>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
8 <requirement type="package" version="1.24.4">numpy</requirement>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
9 <requirement type="package" version="2.0.3">pandas</requirement>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
10 <requirement type="package" version="0.29.0">cobra</requirement>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
11 <requirement type="package" version="5.2.2">lxml</requirement>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
12 <requirement type="package" version="1.4.2">joblib</requirement>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
13 </requirements>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
14
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
15 <command detect_errors="exit_code">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
16 <![CDATA[
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
17 python $__tool_directory__/ras_to_bounds.py
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
18 --tool_dir $__tool_directory__
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
19 --model_selector $cond_model.model_selector
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
20 --cell_class $cell_class
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
21 #if $cond_model.model_selector == 'Custom'
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
22 --model $model
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
23 --model_name $model.element_identifier
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
24 #end if
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
25 --medium_selector $cond_medium.medium_selector
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
26 #if $cond_medium.medium_selector == 'Custom'
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
27 --medium $medium
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
28 #end if
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
29 --ras_selector $cond_ras.ras_choice
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
30 #if $cond_ras.ras_choice == "True"
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
31 --input_ras $cond_ras.input_ras
88
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
32 --classes $cond_ras.classes
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
33 #end if
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
34 --out_log $log
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
35 ]]>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
36 </command>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
37 <inputs>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
38 <conditional name="cond_model">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
39 <expand macro="options_ras_to_bounds_model"/>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
40 <when value="Custom">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
41 <param name="model" argument="--model" type="data" format="json, xml" label="Custom model" />
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
42 </when>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
43 </conditional>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
44
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
45 <conditional name="cond_ras">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
46 <param name="ras_choice" argument="--ras_choice" type="select" label="Do want to use RAS?">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
47 <option value="True" selected="true">Yes</option>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
48 <option value="False">No</option>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
49 </param>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
50 <when value="True">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
51 <param name="input_ras" argument="--input_ras" multiple="true" type="data" format="tabular, csv, tsv" label="RAS matrix:" />
88
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
52 <param name="classes" argument="--classes" type="text" value="None" label="Classes:" help="Write here the the classes to assign to each of the uploaded RAS matrices. Example for two RAS matrices:'cellNormal, cellCancer'. If you uploaded just one matrix, leave default value." />
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
53 </when>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
54 </conditional>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
55
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
56 <conditional name="cond_medium">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
57 <expand macro="options_ras_to_bounds_medium"/>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
58 <when value="Custom">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
59 <param name="medium" argument="--medium" type="data" format="tabular, csv, tsv" label="Custom medium" />
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
60 </when>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
61 </conditional>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
62
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
63 </inputs>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
64
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
65 <outputs>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
66 <data format="txt" name="log" label="RAStoBounds- Log" />
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
67 <data format="tabular" name="cell_class" label="RAStoBounds - Cells class" />
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
68 <collection name="ras_to_bounds" type="list" label="Ras to Bounds">
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
69 <discover_datasets name = "collection" pattern="__name_and_ext__" directory="ras_to_bounds"/>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
70 </collection>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
71
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
72 </outputs>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
73
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
74 <help>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
75
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
76 <![CDATA[
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
77
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
78 What it does
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
79 -------------
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
80
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
81 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.
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
82 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.
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
83 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.
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
84
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
85 Accepted files:
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
86 - A model: JSON or XML file reporting reactions and rules contained in the model.
88
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
87 - RAS matrix: tab-separated RAS file as returned by RAS generator. It can be a collection of RAS files 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.
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
88 - Classes: If multiple RAS matrices are uploaded, then the tool returns a simple file containing for each cell the class it belongs to (cells coming from the same RAS matrix are assigned to the same class). This file is useful in the Flux enrichment analysis tool.
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
89 - Medium: tab-separated file containing lower and upper-bounds of medium reactions.
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
90
88
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
91 Example of custum growth medium file:
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
92
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
93
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
94 +------------+----------------+----------------+
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
95 | Reaction ID| lower_bound | upper_bound |
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
96 +============+================+================+
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
97 | r1 | 0.123167 | 0.371355 |
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
98 +------------+----------------+----------------+
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
99 | r2 | 0.268765 | 0.765567 |
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
100 +------------+----------------+----------------+
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
101
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
102
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
103 Output:
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
104 -------------
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
105
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
106 The tool generates:
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
107 - bounds: reporting the bounds of the model, or cells if RAS is used. Format: tab-separated.
88
c5820d87b4a5 Uploaded
luca_milaz
parents: 87
diff changeset
108 - Classes: a file containing the class of each cell (only if multiple RAS matrices were uploaded). Format: tab-separated.
87
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
109 - a log file (.txt).
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
110 ]]>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
111 </help>
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
112 <expand macro="citations" />
9c802c5cad40 Uploaded
luca_milaz
parents:
diff changeset
113 </tool>