Mercurial > repos > tduigou > dnabot

annotate dnabot.xml @ 2:aeebb663a0d9 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
author tduigou
date Mon, 04 Apr 2022 15:24:55 +0000
parents de6812daba39
children 6dda0879d95a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
1 <tool id="dnabot" name="DNA-Bot" version="@TOOL_VERSION@" profile="21.09">
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
2 <description>DNA assembly using BASIC on OpenTrons</description>
1
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
3 <macros>
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
4 <token name="@TOOL_VERSION@">3.1.0</token>
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
5 </macros>
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
6 <requirements>
1
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">dnabot</requirement>
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
8 </requirements>
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 python -m dnabot.dnabot_app
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
11 #if $adv.default_settings_file
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
12 --default_settings_file '$adv.default_settings_file'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
13 #end if
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
14 nogui
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
15 --construct_path '$construct_file'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 #set files = '" "'.join([str($file) for $file in $plate_files])
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
17 --source_paths "${files}"
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
18 --etoh_well '$adv.etoh_well'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
19 --soc_column '$adv.soc_column'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
20 --output_dir 'output'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
21 && tar -cvf '$dnabot_scripts' 'output'
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
22 ]]></command>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
23 <inputs>
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
24 <param name="construct_file" type="data" format="csv" label="Source Construct" help="File listing constructs to be implemented."/>
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
25 <param name="plate_files" type="data" format="csv" multiple="true" label="Plate files" help="File(s) listing parts to be used in constructs." />
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
26 <section name="adv" title="Advanced Options" expanded="false">
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
27 <param name="default_settings_file" type="data" format="yaml" optional="true" label="Lab settings file" help="Yaml file providing labware IDs and parameter to be used in the Opentrons scripts." />
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
28 <param argument="--etoh_well" type="select" label="Well coordinate for Ethanol" help="Coordinates of the well plate providing ethanol for the purification step.">
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 <option value="A2" >A2</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <option value="A3" >A3</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
31 <option value="A4" >A4</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
32 <option value="A5" >A5</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
33 <option value="A6" >A6</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
34 <option value="A7" >A7</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
35 <option value="A8" >A8</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
36 <option value="A9" >A9</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 <option value="A10" >A10</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
38 <option value="A11" selected="true">A11</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
39 </param>
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
40 <param argument="--soc_column" type="select" label="Column coordinate for SOC" help="Coordinate of the column plate providing SOC media for the transformation step.">
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
41 <option value="1" selected="true">1</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
42 <option value="2" >2</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
43 <option value="3" >3</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
44 <option value="4" >4</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
45 <option value="5" >5</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
46 <option value="6" >6</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
47 <option value="7" >7</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48 <option value="8" >8</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 <option value="9" >9</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50 <option value="10" >10</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51 <option value="11" >11</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 <option value="12" >12</option>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53 </param>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
54 </section>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
55 </inputs>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
56 <outputs>
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
57 <data name="dnabot_scripts" format="tar" />
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58 </outputs>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59 <tests>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60 <test>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
61 <!-- test 1: check if identical outputs are produced with compress option -->
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62 <param name="construct_file" value="constructs.csv" />
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63 <param name="plate_files" value="user_parts_coords.csv,linker_parts_coords.csv"/>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64 <output name="dnabot_scripts" file="dnabot_scripts.tar" compare="sim_size" decompress="True"/>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65 </test>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
66 </tests>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67 <help><![CDATA[
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68 DNA-Bot
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
69 ============
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
70
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
71 **DNA-Bot** tool reads the list of constructs (previously produced by `rpBasicDesign <https://toolshed.g2.bx.psu.edu/view/iuc/rpbasicdesign/cdd6a526bdcf>`_) and the DNA-parts position on the source plates and generates a set of python scripts to drive an Opentrons liquid handling robot for building the plasmids using BASIC assembly method (as decribed in `Storch2015 <https://doi.org/10.1021/sb500356d>`_). Optional parameters can be set by the user to define the plastic labwares to be used, and set protocol parameters such as washing or incubation times for purification step by providing a YAML settings file.
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
72
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
73 Inputs
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
74 ------
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
75
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
76 * **Source Construct**: CSV file listing constructs to be implemented.
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
77 * **Plate files**: File(s) listing parts to be used in constructs.
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
78 * **Well coordinate for Ethanol**: (string) Coordinates of the well plate providing ethanol for the purification step. Default: A11
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
79 * **Column coordinate for SOC**: (integer) Coordinate of the column plate providing SOC media for the transformation step. Default: 1.
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
80 * **Lab settings file**: Yaml file providing labware IDs and parameter to be used in the Opentrons scripts: `Default settings <https://github.com/BASIC-DNA-ASSEMBLY/DNA-BOT/blob/master/dnabot/default_settings.yaml>`_.
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
81
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
82
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
83 Ouput
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
84 -----
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
85
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
86 * **Dnabot scripts**: DNA-Bot scripts in TAR format which implement the 4 assembly steps and metainformation to keep track of parameters.
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
87
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
88 Version
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
89 -------
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
90
1
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
91 3.1.0
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
92
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
93 Authors
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
94 -------
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
95
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
96 * **Matthew C Haines**
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
97 * Thomas Duigou
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
98
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
99 License
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
100 -------
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
101
2
aeebb663a0d9 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 1
diff changeset
102 `MIT <https://github.com/BASIC-DNA-ASSEMBLY/DNA-BOT/blob/master/LICENSE>`_
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
103
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
104
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
105 Acknowledgments
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
106 ---------------
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
107
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
108 * Marko Storch
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
109 * Geoff Baldwin
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
110 ]]></help>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
111 <citations>
1
de6812daba39 "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
112 <citation type="doi">10.1093/synbio/ysaa010</citation>
0
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
113 </citations>
6d55c77a17ab "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
114 </tool>