annotate flux_sampling.xml @ 104:bf759eb48bf2 draft

Uploaded
author luca_milaz
date Thu, 27 Jun 2024 12:07:50 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
104
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="fluxSampling" name="COBRAxy Model sampling" version="2.0.0">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
2
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
6
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
7 <requirements>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
8 <requirement type="package" version="0.29.0">cobra</requirement>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
9 <requirement type="package" version="4.9.3">lxml</requirement>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
10 </requirements>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
11
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
12 <command detect_errors="exit_code">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
13 <![CDATA[
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
14 python $__tool_directory__/flux_sampling.py
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
15 --input $input
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
16 --name $input.element_identifier
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
17 #if $algorithm_param.algorithm == 'OPTGP':
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
18 --thinning $thinning
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
19 --n_batches $n_batches
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
20 --n_samples $n_samples
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
21 --seed $seed
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
22 --output_format $output_format
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
23 --out_log $log
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
24 ]]>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
25 </command>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
26 <inputs>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
27 <param name="input" argument="--input" type="data" format="xml, json" label="Model:" />
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
28
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
29 <conditional name="algorithm_param">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
30 <param name="algorithm" argument="--algorithm" type="select" label="Choose sampling algorithm:">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
31 <option value="CBS" selected="true">CBS</option>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
32 <option value="OPTGP">OPTGP</option>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
33 </param>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
34 <when value="OPTGP">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
35 <param name="thinning" argument="--thinning" type="integer" label="Thinning:" />
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
36 </when>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
37
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
38 </conditional>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
39
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
40 <param name="n_batches" argument="--n_batches" type="integer" label="Batches:" default="1"/>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
41
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
42 <param name="n_samples" argument="--n_samples" type="integer" label="Samples:" default="1000"/>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
43
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
44 <param name="seed" argument="--seed" type="integer" label="Seed:" default="0"/>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
45
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
46 <param name="output_format" argument="--output_format" type="select" label="Output files format:">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
47 <option value="p" selected="true">pickle extension (binary, non-editable, pre-parsed)</option>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
48 <option value="csv">Comma Separated Values (csv text file, editable, raw)</option>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
49 </param>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
50 </inputs>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
51
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
52 <outputs>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
53 <data format="txt" name="log" label="fluxSampling - $name - Log" />
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
54
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
55 <collection name="results" type="list" label="Model sampling result ($output_format)">
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
56 <discover_datasets name = "collection" pattern="__name_and_ext__" directory="result"/>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
57 </collection>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
58 </outputs>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
59
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
60 <help>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
61 <![CDATA[
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
62 What it does
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
63 -------------
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
64
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
65 This tool generates feasible samples starting from a model in JSON or XML format by using CBS (Corner-based sampling) and OPTGP (mproved Artificial Centering Hit-and-Run sampler) sampling algorithms.
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
66
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
67 Accepted files:
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
68 - A model: JSON or XML file reporting reactions and rules contained in the model.
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
69
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
70
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
71 Output:
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
72 -------------
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
73
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
74 The tool generates:
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
75 - Samples: reporting the sampled fluxes for each reaction in the custom model given. Format: csv or pickle.
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
76 - a log file (.txt).
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
77 ]]>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
78 </help>
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
79 <expand macro="citations" />
bf759eb48bf2 Uploaded
luca_milaz
parents:
diff changeset
80 </tool>