annotate instructor.xml @ 12:337634672ac5 draft

planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
author tduigou
date Tue, 21 Mar 2023 09:43:58 +0000
parents 401d55846cbf
children 6e84e7a070f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
1 <tool id="icfree_instructor" name="iCFree instructor" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" license="@LICENCE@">
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
2 <description>Generates a list of Echo-compatible instructions to prepare samples</description>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
3 <macros>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
4 <import>macros.xml</import>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
5 </macros>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
6 <expand macro="requirements"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
7 <expand macro="stdio"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
9 #set sps = [], sws = [], dps = [], dws = []
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
10 #for $x in $plates_generator:
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
11 #set $fname = str($x.element_identifier)
8
c8bd090fa47f planemo upload for repository https://github.com/brsynth/icfree-ml commit 1d40e70482d76c2f672071584b43a358aa5a0de7
tduigou
parents: 7
diff changeset
12 ln -sfn '$x' '$fname' &&
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
13 #if $fname.startswith('source') and $fname.endswith('json'):
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
14 #silent sps.append($fname)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
15 #else if $fname.startswith('source') and $fname.endswith('tsv'):
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
16 #silent sws.append($fname)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
17 #else if $fname.startswith('destination') and $fname.endswith('json'):
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
18 #silent dps.append($fname)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
19 #else if $fname.startswith('destination') and $fname.endswith('tsv'):
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
20 #silent dsws.append($fname)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
21 #end if
5
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
22 #end for
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
23 python -m icfree.instructor
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
24 --source_plates '" "'.join($sps)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
25 --source_wells '" "'.join($sws)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
26 --dest_plates '" "'.join($dps)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
27 --dest_wells '" "'.join($dws)
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
28 -spt '$source_plate'
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
29 --robot '$robot'
4
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
30 --output-folder '.' &&
9
eac0d2bd8dd8 planemo upload for repository https://github.com/brsynth/icfree-ml commit 85914678915691d3ec8f0477f8bc7bcfa8518590
tduigou
parents: 8
diff changeset
31 mv instructions.csv '$output_instruction' &&
11
401d55846cbf planemo upload for repository https://github.com/brsynth/icfree-ml commit 36522574cb42262281f2f6501921cc4b534702bb-dirty
tduigou
parents: 10
diff changeset
32 #if not os.path.isfile('volume_warning.tsv')
9
eac0d2bd8dd8 planemo upload for repository https://github.com/brsynth/icfree-ml commit 85914678915691d3ec8f0477f8bc7bcfa8518590
tduigou
parents: 8
diff changeset
33 touch volume_warning.tsv &&
eac0d2bd8dd8 planemo upload for repository https://github.com/brsynth/icfree-ml commit 85914678915691d3ec8f0477f8bc7bcfa8518590
tduigou
parents: 8
diff changeset
34 #end if
eac0d2bd8dd8 planemo upload for repository https://github.com/brsynth/icfree-ml commit 85914678915691d3ec8f0477f8bc7bcfa8518590
tduigou
parents: 8
diff changeset
35 mv volume_warning.tsv '$output_warning'
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
36 ]]></command>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
37 <inputs>
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
38 <param name="plates_generator" type="data_collection" collection_type="list" format="json,tabular" label="Source/Destination corresponding to plate/wells" help="Output from iCFree plates generator"/>
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
39 <param name="robot" type="select" label="Robot name">
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
40 <option value="ECHO" selected="true">ECHO</option>
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
41 </param>
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
42 <param name="source_plate" type="select" label="Source plate type">
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
43 <option value="384PP_AQ_GP3" selected="true">384PP_AQ_GP3</option>
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
44 <option value="384_AQ_CP">384_AQ_CP</option>
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
45 </param>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
46 </inputs>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
47 <outputs>
5
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
48 <data name="output_warning" format="tsv" label="${tool.name} - Warning" />
4
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
49 <data name="output_instruction" format="csv" label="${tool.name} - Instruction" />
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
50 </outputs>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
51 <tests>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
52 <test>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
53 <!-- test 1: check if identical outputs are produced with default parameters -->
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
54 <param name="plates_generator">
5
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
55 <collection type="list">
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
56 <element name="plates_generator_source_plate_1" value="plates_generator_source_plate_1.test-1.json" />
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
57 <element name="plates_generator_source_plate_1.test-1.tsv" value="plates_generator_source_plate_1.test-1.tsv" />
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
58 <element name="plates_generator_destination_plate_1.test-1.json" value="plates_generator_destination_plate_1.test-1.json" />
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
59 <element name="plates_generator_destination_plate_1.test-1.tsv" value="plates_generator_destination_plate_1.test-1.tsv" />
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
60 </collection>
190889521a9e planemo upload for repository https://github.com/brsynth/icfree-ml commit 5f2c17e82747f20abcdf1f11dee4b5bd414295ef
tduigou
parents: 4
diff changeset
61 </param>
4
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
62 <output name="output_warning" ftype="tabular">
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
63 <assert_contents>
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
64 <has_n_lines n="12"/>
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
65 <has_line_matching expression="^Parameter\tMin\tMax\tPlate$"/>
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
66 </assert_contents>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
67 </output>
4
fba5810f3946 planemo upload for repository https://github.com/brsynth/icfree-ml commit 79b4751f34792a1a346ada38f7b6f64571dd51e9
tduigou
parents: 1
diff changeset
68 <output name="output_instruction" file="instructor_instructions.csv" ftype="csv" compare="diff" />
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
69 </test>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
70 </tests>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
71 <help><![CDATA[
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
72 Instructor
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
73 ==========
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
74
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
75 The module generates a list of instructions to perform the experiment.
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
76
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
77 Input
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
78 -----
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
79 Required:
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
80 * **Source plates file**: description of the source plates (source well name, source well volume...) (JSON format)
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
81 * **Destination plates file**: description of the destination plates (destination well name, destination well volume...) (JSON format)
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
82
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
83 Advanced options:
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
84 -----------------
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
85 * **Robot name**: name of the robot to generate instructions for (default: "echo")
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
86
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
87 Output
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
88 ------
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
89 * **instructions**: contains the instructions to perform the experiment
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
90 * **volumes_warning**: contains the volumes that may cause issues with the chosen robot
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
91 ]]></help>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
92 <expand macro="creator"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
93 <expand macro="citation"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
94 </tool>