annotate sampler.xml @ 2:b2bc4ebe12e4 draft

planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
author tduigou
date Sat, 01 Jul 2023 01:31:35 +0000
parents 877d4c7ea6b9
children 596e600be71f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
1 <tool id="doe_synbio_sampler" name="iCFree sampler" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" license="@LICENCE@">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
2 <description>Generate data points using latin hypercube sampling (LHS)</description>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
3 <macros>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
4 <import>macros.xml</import>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
5 <token name="@TOOL_VERSION@">2.1.1</token>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
6 </macros>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
7 <requirements>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">icfree</requirement>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
9 </requirements>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
10 <expand macro="stdio"/>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
12 python -m icfree.sampler
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
13 '$cfps_file'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
14 --nb-sampling-steps '$adv.nb_sampling_steps'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
15 --nb-samples '$nb_samples'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
16 #if str($adv.sampling_ratio) != ""
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
17 #set ratios = ' '.join(['"' + $x + '"' for $x in $adv.sampling_ratio.split()])
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
18 --sampling-ratios $ratios
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
19 #end if
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
20 #if str($adv.seed_cond.seed_param) == 'not_random'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
21 --seed '$adv.seed_cond.seed'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
22 #end if
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
23 --output-format 'tsv'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
24 --output-folder . &&
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
25 mv sampling.tsv '$output_sampling'
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
26 ]]></command>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
27 <inputs>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
28 <param name="cfps_file" type="data" format="tabular" label="CFPS parameters and features" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
29 <param name="nb_samples" type="integer" value="99" min="1" max="198" label="Number of samples to generate" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
30 <section name="adv" title="Advanced Options" expanded="false">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
31 <param name="nb_sampling_steps" type="integer" value="5" min="1" max="10" label="Number of values for all factors when performing the sampling" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
32 <param name="sampling_ratio" type="text" value="" label="Ratios associated for all factors" help="Only float, space separated, are allowed">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
33 <validator type="regex" message="Float separated by a space between in the range: 0.0 - 1.0">^(?:(0.\d+|1\.0)(\s0?\.\d+|1\.0)*)*$</validator>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
34 </param>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
35 <conditional name="seed_cond">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
36 <param name="seed_param" type="select" label="Seed" help="Choose a seed or let it as random">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
37 <option value="random" selected="true">random</option>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
38 <option value="not_random">fixed</option>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
39 </param>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
40 <when value="random"/>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
41 <when value="not_random">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
42 <param name="seed" type="text" value="0" label="Seed value" help="Only integer allowed">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
43 <validator type="empty_field" message="Not empty, select random"/>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
44 <validator type="regex" message="Only integer allowed">^(?:\d+)$</validator>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
45 </param>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
46 </when>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
47 </conditional>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
48 </section>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
49 </inputs>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
50 <outputs>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
51 <data name="output_sampling" format="tabular" label="${tool.name}" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
52 </outputs>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
53 <tests>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
54 <!-- test 1: check if identical outputs are produced with default parameters -->
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
55 <test>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
56 <param name="cfps_file" value="converter_proCFPS_parameters.tsv" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
57 <param name="seed_param" value="not_random" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
58 <param name="seed" value="0" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
59 <output name="output_sampling" file="sampler_sampling.test-1.tsv" ftype="tabular" compare="diff" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
60 </test>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
61 <!-- test 2: advanced arguments -->
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
62 <test>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
63 <param name="cfps_file" value="converter_proCFPS_parameters.tsv" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
64 <param name="nb_sampling_steps" value="3" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
65 <param name="nb_samples" value="100" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
66 <param name="sampling_ratio" value="0.4 0.2 0.3" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
67 <param name="seed_param" value="not_random" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
68 <param name="seed" value="0" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
69 <param name="nb_samples" value="100" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
70 <output name="output_sampling" file="sampler_sampling.test-2.tsv" ftype="tabular" compare="diff" />
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
71 </test>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
72 </tests>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
73 <help><![CDATA[
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
74 Sampler
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
75 =======
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
76
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
77 This module generates a list of values for all parameters given in the input file.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
78 The values are generated using a Latin Hypercube Sampling (LHS) method (lhs function from the pyDOE package).
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
79 The number of values generated is given by the user and the values are saved in csv or tsv file.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
80
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
81 It is important to note that the user can pass some values that he whishes to combine. In this case, we are dealing with discrete space, and because LHS is working on continuous space the result sampling can contain duplicates.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
82 To avoid this, we have set some filters to select the appropriate sampling method:
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
83
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
84 * If the result sampling contain duplicates, then we replace them by random samples.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
85 * Proceed with full random sampling.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
86 * Generate all the combinations.
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
87
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
88 Input
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
89 -----
2
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
90
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
91 Below is an example of an input file:
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
92
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
93 | Parameter | maxValue | Ratios |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
94 |-----------|----------|---------------------|
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
95 | CP | 125 | 0.0 0.1 0.3 0.5 1.0 |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
96 | CPK | 125 | 1 |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
97 | tRNA | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
98 | AA | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
99 | ribosomes | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
100 | mRNA | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
101 | Mg | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
102 | K | 125 | |
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
103
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
104 The first column is the parameter (or factor) names.
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
105
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
106 The second column is the maxValue of the parameter that will be used in the sampling.
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
107
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
108 The third column is the specific ratios we want to have for this parameter. If nothing defined, then take ratios given in program options.
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
109 If one single number is given, then take this number as a const value.
b2bc4ebe12e4 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit b29963ef22900ba666d9be11f1dc09e4e3febf8b
tduigou
parents: 0
diff changeset
110 If no value is given, then take the default ratios (`nb_samples` linear ratios from 0 to 1).
0
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
111
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
112 Advanced options:
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
113 -----------------
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
114 * **Number of sampling steps**: Number of values for all factors when performing the sampling (default: 5)
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
115 * **Sampling ratios**: Ratios for all factors when performing the sampling
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
116 * **Number of samples**: Number of samples to generate for all factors when performing the sampling (default: 99)
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
117
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
118 Output
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
119 ------
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
120 * a TSV file with the sampling values for each parameter
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
121 ]]></help>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
122 <expand macro="creator"/>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
123 <citations>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
124 <citation type="bibtex">
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
125 @unpublished{icfree
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
126 author = {Joan Hérisson, Yorgo El Moubayed},
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
127 title = {{icfree}},
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
128 url = {https://github.com/brsynth/icfree-ml/},
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
129 }
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
130 </citation>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
131 </citations>
877d4c7ea6b9 planemo upload for repository ['https://github.com/brsynth/icfree-ml', 'https://github.com/pablocarb/doebase'] commit 6c01728900e4ebd1a833a7e7d697f61561d86dc6-dirty
tduigou
parents:
diff changeset
132 </tool>