annotate instructor.xml @ 21:80516b9b1caa draft

planemo upload for repository https://github.com/brsynth/icfree-ml commit b669b043a7cd633a9ba1ac2cf2a7f3ed09c3e92e
author tduigou
date Tue, 10 Sep 2024 08:17:10 +0000
parents ab9f4c430d8f
children 5ba334474596
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
ab9f4c430d8f planemo upload for repository https://github.com/brsynth/icfree-ml commit 0cc2a71b09ae9b47c72b1a34c531a858335eb772
tduigou
parents: 19
diff changeset
1 <tool id="icfree_instructor" name="iCFree instructor" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" license="MIT">
0
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[
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
9 python -m icfree.instructor
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
10 '$source_plate_file'
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
11 '$destination_plate_file'
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
12 'instructor.csv'
21
80516b9b1caa planemo upload for repository https://github.com/brsynth/icfree-ml commit b669b043a7cd633a9ba1ac2cf2a7f3ed09c3e92e
tduigou
parents: 20
diff changeset
13 --source_plate_type '$adv.source_plate_type'
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
14 --max_transfer_volume '$max_transfer_volume'
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
15 #if str($adv.split_threshold) != ''
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
16 --split_threshold '$split_threshold'
12
337634672ac5 planemo upload for repository https://github.com/brsynth/icfree-ml commit 1568ac8d21ca92c2325ef661498ee7a4b622ae5e
tduigou
parents: 11
diff changeset
17 #end if
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
18 #if str($adv.split_components) != ''
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
19 --split_components '$split_components'
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
20 #end if
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
21 ]]></command>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
22 <inputs>
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
23 <param name="source_plate_file" type="data" format="csv" label="Source corresponding to plate/wells" help="Output from iCFree plates designer"/>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
24 <param name="destination_plate_file" type="data" format="csv" label="Destination corresponding to plate/wells" help="Output from iCFree plates designer"/>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
25 <section name="adv" title="Advanced Options" expanded="false">
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
26 <param name="source_plate_type" type="text" value="default:384PP_AQ_GP3" label="Source plate type" help="Comma-separated list of component and plate type pairs, e.g., 'Component_1:384PP_AQ_CP,Component_2:384PP_AQ_GP3'. Default for all is default:384PP_AQ_GP3." >
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
27 <validator type="empty_field" message="Source plate type is required"/>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
28 </param>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
29 <param argument="max_transfer_volume" type="integer" min="1" max="50000" value="500" label="Maximum transfer volume" help="Maximum volume for a single transfer. If not specified, no splitting will be performed." />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
30 <param argument="split_threshold" type="integer" min="1" max="50000" value="500" label="Split threshold" help="Volume threshold above which transfers need to be split. If not specified, no splitting will be performed." />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
31 <param name="split_components" type="text" optional="true" label="Split components" help="Comma-separated list of component names to create separate files for." >
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
32 </param>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
33 </section>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
34 </inputs>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
35 <outputs>
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
36 <collection name="output_instructor" type="list" label="${tool.name} - Instructor">
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
37 <discover_datasets pattern="__designation_and_ext__" format="csv" directory="."/>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
38 </collection>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
39 </outputs>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
40 <tests>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
41 <test>
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
42 <!-- python -m icfree.instructor plates_designer.source_plate.test-2.csv plates_designer.destination_plate.test-2.csv 'instructor.test-1.csv' -source_plate_type 'default:384PP_AQ_GP3' -max_transfer_volume '500' -split_threshold '500' -->
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
43 <param name="source_plate_file" value="plates_designer.source_plate.test-2.csv" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
44 <param name="destination_plate_file" value="plates_designer.destination_plate.test-2.csv" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
45 <output_collection name="output_instructor" type="list" count="1">
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
46 <element name="instructor" file="instructor.test-1.csv" ftype="csv" compare="diff" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
47 </output_collection>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
48 </test>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
49 <test>
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
50 <!-- python -m icfree.instructor plates_designer.source_plate.test-2.csv plates_designer.destination_plate.test-2.csv 'instructor.csv' -source_plate_type 'Hela lysate:384PP_AQ_CP,Access prot 50X:384PP_AQ_GP3,Reaction mix:384PP_AQ_GP3,RNA 1ug/uL:384PP_AQ_GP3' -max_transfer_volume '500' -split_threshold '500' -split_components 'Hela lysate,Access prot 50X' -->
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
51 <param name="source_plate_file" value="plates_designer.source_plate.test-2.csv" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
52 <param name="destination_plate_file" value="plates_designer.destination_plate.test-2.csv" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
53 <param name="source_plate_type" value="Hela lysate:384PP_AQ_CP,Access prot 50%:384PP_AQ_GP3,Reaction mix:384PP_AQ_GP3,RNA 1ug/uL:384PP_AQ_GP3" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
54 <param name="split_components" value="Hela lysate,Access prot 50%" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
55 <output_collection name="output_instructor" type="list" count="3">
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
56 <element name="instructor" file="instructor.test-2.csv" ftype="csv" compare="diff" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
57 <element name="instructor_Hela lysate" file="instructor.hela.test-2.csv" ftype="csv" compare="diff" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
58 <!--
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
59 <element name="instructor_Access prot 50X" file="instructor.access.test-2.csv" ftype="csv" compare="diff" />
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
60 -->
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
61 </output_collection>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
62 </test>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
63 </tests>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
64 <help><![CDATA[
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
65 Instructor
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
66 ==========
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
67 The module generates a list of instructions for handling the generated plates.
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
68
19
f5df51d88aac planemo upload for repository https://github.com/brsynth/icfree-ml commit 7640e2163acff6c925cba16188eaa4ce54639180
tduigou
parents: 18
diff changeset
69 ]]></help>
0
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
70 <expand macro="creator"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
71 <expand macro="citation"/>
f60f2f6ec0cc planemo upload for repository https://github.com/brsynth/icfree-ml commit d87d4a4d7c894f2d884a71a2acc35f93bc5bbe4b
tduigou
parents:
diff changeset
72 </tool>