changeset 468:77ed5c696865 draft

Uploaded
author luca_milaz
date Mon, 22 Sep 2025 15:14:26 +0000
parents e585aa3cb027
children 5f02f7e4ea9f
files COBRAxy/flux_simulation_beta.xml
diffstat 1 files changed, 30 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/COBRAxy/flux_simulation_beta.xml	Mon Sep 22 14:41:39 2025 +0000
+++ b/COBRAxy/flux_simulation_beta.xml	Mon Sep 22 15:14:26 2025 +0000
@@ -36,23 +36,18 @@
             --name $names
         #end if
         
-        #if $sampling_params.enable_sampling == 'true':
+        --sampling_enabled $sampling_params.sampling_enabled
+        
+        #if $sampling_params.sampling_enabled == 'true':
             --thinning 0
-            #if $sampling_params.algorithm_param.algorithm == 'OPTGP':
-                --thinning $sampling_params.algorithm_param.thinning
+            #if $sampling_params.algorithm == 'OPTGP':
+                --thinning $sampling_params.thinning
             #end if
-            --algorithm $sampling_params.algorithm_param.algorithm
+            --algorithm $sampling_params.algorithm
             --n_batches $sampling_params.n_batches
             --n_samples $sampling_params.n_samples
             --seed $sampling_params.seed
             --output_type "${",".join(map(str, $sampling_params.output_types))}"
-        #else:
-            --thinning 0
-            --algorithm CBS
-            --n_batches 1
-            --n_samples 0
-            --seed 0
-            --output_type "mean"
         #end if
         
         --output_type_analysis "${",".join(map(str, $output_types_analysis))}"
@@ -67,15 +62,15 @@
 
     <inputs>
         <conditional name="model_and_bounds">
-            <param name="model_and_bounds" argument="--model_and_bounds" type="select" label="Upload model:" help="Choose whether to upload the model and bounds in separate files or to upload multiple complete model files.">
+            <param name="model_and_bounds" argument="--model_and_bounds" type="select" label="Upload mode:" help="Choose whether to upload the model and bounds in separate files or to upload multiple complete model files.">
                 <option value="True" selected="true">Model + bounds (separate files)</option>
                 <option value="False">Multiple complete models</option>
             </param>
 
             <when value="True">
-                <param name="model_upload" argument="--model_upload" type="data" format="csv,tsv,tabular" multiple="false"
-                    label="Model file:"
-                    help="Upload a CSV/TSV file containing information generated by the Model Initialization tool." />
+                <param name="model_upload" argument="--model_upload" type="data" format="csv,tsv,tabular"
+                    label="Model (rules) file:"
+                    help="Upload a CSV/TSV file that contains the model reaction rules. Recommended columns: ReactionID, Reaction (formula), Rule (GPR). Optional columns: name, lower_bound, upper_bound, InMedium. If bounds are present here they may be overridden by separate bound files." />
 
                 <param name="inputs" argument="--inputs" multiple="true" type="data" format="tabular,csv,tsv"
                     label="Bound file(s):"
@@ -90,7 +85,7 @@
         </conditional>
 
         <conditional name="sampling_params">
-            <param name="enable_sampling" type="boolean" display="checkboxes" checked="false" label="Enable sampling" help="Check this box to perform flux sampling in addition to optimization analyses"/>
+            <param name="sampling_enabled" argument="--sampling_enabled" type="boolean" display="checkboxes" checked="false" label="Enable sampling" help="Enable flux sampling"/>
             
             <when value="true">
                 <conditional name="algorithm_param">
@@ -103,26 +98,31 @@
                     </when>
                 </conditional>
 
-                <param name="n_samples" argument="--n_samples" type="integer" label="Samples:" value="1000" help="Number of samples to generate."/>
+                <param name="n_samples" argument="--n_samples" type="integer" label="Samples:" value="1000"/>
                 <param name="n_batches" argument="--n_batches" type="integer" label="Batches:" value="1" help="This is useful for computational performances."/>
+                <param name="seed" argument="--seed" type="integer" label="Seed:" value="0" help="Random seed."/>
 
                 <param type="select" argument="--output_types" multiple="true" name="output_types" label="Choose outputs from sampling">
                     <option value="mean" selected="true">Mean</option>
-                    <option value="median" selected="false">Median</option>
-                    <option value="quantiles" selected="false">Quantiles</option>
+                    <option value="median" selected="true">Median</option>
+                    <option value="quantiles" selected="true">Quantiles</option>
                     <option value="fluxes" selected="false">All fluxes</option>
                 </param>
-
-                <param name="seed" argument="--seed" type="integer" label="Seed:" value="0" help="Random seed for sampling algorithms."/>
             </when>
+            
             <when value="false">
-                <!-- Hidden parameters with default values when sampling is disabled -->
+                <!-- Hidden parameters when sampling is disabled -->
+                <param name="algorithm" type="hidden" value="CBS"/>
+                <param name="n_samples" type="hidden" value="1000"/>
+                <param name="n_batches" type="hidden" value="1"/>
+                <param name="seed" type="hidden" value="0"/>
+                <param name="output_types" type="hidden" value="mean"/>
             </when>
         </conditional>
 
         <param type="select" argument="--output_types_analysis" multiple="true" name="output_types_analysis" label="Choose outputs from optimization">
             <option value="pFBA" selected="false">pFBA</option>
-            <option value="FVA" selected="true">FVA</option>
+            <option value="FVA" selected="false">FVA</option>
             <option value="sensitivity" selected="false">Sensitivity reaction knock-out (Biomass)</option>
         </param>
 
@@ -151,20 +151,21 @@
 What it does
 -------------
 
-This tool generates flux distributions for each samples using:
-1. a sampling-based strategy (optional): CBS (Corner-based sampling) or OPTGP (Improved Artificial Centering Hit-and-Run sampler) algorithms.
-2. an optimization-based strategy: parsimonious-FBA (optimized by Biomass), FVA (with configurable optimality percentage), Biomass sensitivity analysis (single reaction knock-out)
+This tool generates flux samples starting from metabolic models using CBS (Corner-based sampling) or OPTGP (Improved Artificial Centering Hit-and-Run sampler) algorithms.
 
 Two upload modes are supported:
-1. **Model + bounds**: Upload one base model (tabular file) and multiple bound files (one per context/cell type)
+1. **Model + bounds**: Upload one base model and multiple bound files (one per context/cell type)
 2. **Multiple complete models**: Upload multiple complete model files, each with integrated bounds
 
-**Sampling (optional)**: When enabled, it can return sampled fluxes by applying summary statistics: 
+It can return sampled fluxes by applying summary statistics: 
    - mean
    - median
    - quantiles (0.25, 0.50, 0.75)
 
-**Optimization**: Always available with FVA as the default analysis method.
+Flux analysis can be performed over the metabolic model:
+   - parsimonious-FBA (optimized by Biomass)
+   - FVA (with configurable optimality percentage)
+   - Biomass sensitivity analysis (single reaction knock-out)
 
 Output:
 -------------
@@ -179,5 +180,4 @@
 ]]>
     </help>
     <expand macro="citations_fluxes" />
-
 </tool>
\ No newline at end of file