diff optdoe.xml @ 1:c3f32929a4b7 draft

"planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
author tduigou
date Wed, 02 Feb 2022 18:11:50 +0000
parents 7f13e58f1532
children 593e0f787172
line wrap: on
line diff
--- a/optdoe.xml	Thu Dec 16 13:23:29 2021 +0000
+++ b/optdoe.xml	Wed Feb 02 18:11:50 2022 +0000
@@ -1,7 +1,10 @@
-<tool id="OptDoE" name="Design of Experiment" version="2.0.1">
+<tool id="optdoe" name="Design of Experiment" version="@TOOL_VERSION@" profile="19.09">
     <description>An optimal design of experiments (DoE) base package for synthetic biology</description>
+    <macros>
+        <token name="@TOOL_VERSION@">2.0.2</token>
+    </macros>
     <requirements>
-        <requirement type="package" version="v2.0.1">doebase</requirement>
+        <requirement type="package" version="@TOOL_VERSION@">doebase</requirement>
     </requirements>
     <command detect_errors="exit_code"><![CDATA[
         python -m doebase
@@ -22,12 +25,133 @@
     <inputs>
         <param name="genes_file" type="data" format="csv" label="Genes" />
         <section name="adv" title="Advanced Options" expanded="false">
-            <param name="genes_sbol_file" type="data" format="xml" label="Optimised Genes" optional="true"/>
-            <param name="ref_parts_file" type="data" format="xml" value="None" label="Ref Parts" optional="true"/>
-            <param name="libsize" type="integer" value="32" label="Maximal library size" />
-            <param name="get_sequences" type="boolean" label="" checked="true" />
-            <param name="backtranslate" type="boolean" label="" checked="true" />
-            <param name="codon_table" type="text" value="Eecoli.cut" label="" />
+            <param name="genes_sbol_file" type="data" format="xml" optional="true" label="Optimised Genes" />
+            <param name="ref_parts_file" type="data" format="csv" value="None" optional="true" label="Ref Parts (default: E. coli compliant)"/>
+            <param name="libsize" type="integer" value="32" min="32" label="Maximal library size" />
+            <param name="get_sequences" type="boolean" checked="true" label="Get sequences" />
+            <param name="backtranslate" type="boolean" checked="true" label="Back translate" />
+            <param name="codon_table" type="select" label="Codon Table">
+                <option value="Eecoli.cut">Escherichia coli K12</option>
+                <option value="Ehuman.cut">Homo sapiens</option>
+                <option value="Eacica.cut">Acinetobacter calcoaceticus</option>
+                <option value="Eagrtu.cut">Agrobacterium tumefaciens str C58</option>
+                <option value="Eanasp.cut">Anabaena sp</option>
+                <option value="Earath.cut">Arabidopsis thaliana</option>
+                <option value="Eazovi.cut">Azotobacter vinelandii</option>
+                <option value="Ebacme.cut">Bacillus megaterium</option>
+                <option value="Ebacst.cut">Geobacillus stearothermophilus</option>
+                <option value="Ebacsu.cut">Bacillus subtilis</option>
+                <option value="Ebacsu_high.cut">Bacillus subtilis (high)</option>
+                <option value="Ebommo.cut">Bombyx mori (silkmoth)</option>
+                <option value="Ebovin.cut">Bos taurus</option>
+                <option value="Ebpphx.cut">Bacteriophage phi-X174</option>
+                <option value="Ebraja.cut">Bradyrhizobium japonicum USDA 110</option>
+                <option value="Ebrana.cut">Brassica napus (rape)</option>
+                <option value="Ebrare.cut">Brachydanio rerio (zebrafish)</option>
+                <option value="Ecaeel.cut">Caenorhabditis elegans (nematode)</option>
+                <option value="Ecanal.cut">Candida albicans</option>
+                <option value="Ecanfa.cut">Canis familiaris (dog)</option>
+                <option value="Ecaucr.cut">Caulobacter crescentus CB15</option>
+                <option value="Echick.cut">Gallus gallus (chicken)</option>
+                <option value="Echlre.cut">Chlamydomonas reinhardtii</option>
+                <option value="Echltr.cut">Chlamydia trachomatis D UW-3 CX</option>
+                <option value="Ecloab.cut">Clostridium acetobutylicum ATCC 824</option>
+                <option value="Ecrigr.cut">Cricetulus greseus (hamster)</option>
+                <option value="Ecyapa.cut">Cyanophora paradoxa</option>
+                <option value="Ebraja.cut">Bradyrhizobium japonicum USDA 110</option>
+                <option value="Ebrana.cut">Brassica napus (rape)</option>
+                <option value="Ebrare.cut">Brachydanio rerio (zebrafish)</option>
+                <option value="Ecaeel.cut">Caenorhabditis elegans (nematode)</option>
+                <option value="Ecanal.cut">Candida albicans</option>
+                <option value="Ecanfa.cut">Canis familiaris (dog)</option>
+                <option value="Ecaucr.cut">Caulobacter crescentus CB15</option>
+                <option value="Echick.cut">Gallus gallus (chicken)</option>
+                <option value="Echlre.cut">Chlamydomonas reinhardtii</option>
+                <option value="Echltr.cut">Chlamydia trachomatis D UW-3 CX</option>
+                <option value="Ecloab.cut">Clostridium acetobutylicum ATCC 824</option>
+                <option value="Ecrigr.cut">Cricetulus greseus (hamster)</option>
+                <option value="Ecyapa.cut">Cyanophora paradoxa</option>
+                <option value="Edicdi.cut">Dictyostelium discoideum</option>
+                <option value="Edicdi_high.cut">Dictyostelium discoideum (high)</option>
+                <option value="Edrome.cut">Drosophila melanogaster</option>
+                <option value="Edrome_high.cut">Drosophila melanogaster (high)</option>
+                <option value="Eecoli_high.cut">Escherichia coli K12 (high)</option>
+                <option value="Eemeni.cut">Emericella nidulans</option>
+                <option value="Eemeni_mit.cut">Emericella nidulans mitochondrion</option>
+                <option value="Eemeni_high.cut">Emericella nidulans highly expressed</option>
+                <option value="Eerwct.cut">Erwinia carotovora subsp atroseptica SCRI1043</option>
+                <option value="Ehaein.cut">Haemophilus influenzae Rd KW20</option>
+                <option value="Ehalma.cut">Haloarcula marismortui ATCC 43049 (Halobacterium marismortui)</option>
+                <option value="Ehalsa.cut">Halobacterium salinarum NRC-1 (Halobacterium halobium)</option>
+                <option value="Ehorvu.cut">Hordeum vulgare subsp vulgare (Barley)</option>
+                <option value="Eklepn.cut">Klebsiella pneumoniae</option>
+                <option value="Eklula.cut">Kluyveromyces lactis NRRL Y-1140</option>
+                <option value="Elacdl.cut">Lactococcus lactis subsp lactis Il1403 L. delbrueckii subsp lactis</option>
+                <option value="Elyces.cut">Lycopersicon esculentum (tomato)</option>
+                <option value="Emacfa.cut">Macaca fascicularis</option>
+                <option value="Emaize.cut">Zea mays</option>
+                <option value="Emaize_chl.cut">Zea mays chloroplast</option>
+                <option value="Emammal_high.cut">Mammalian species (high)</option>
+                <option value="Emanse.cut">Manduca sexta</option>
+                <option value="Emarpo_chl.cut">Marchantia polymorpha chloroplast (liverwort)</option>
+                <option value="Emedsa.cut">Medicago sativa</option>
+                <option value="Emetth.cut">Methanothermobacter thermautotrophicus str Delta H</option>
+                <option value="Emouse.cut">Mus musculus</option>
+                <option value="Emyctu.cut">Mycobacterium tuberculosis H37Rv</option>
+                <option value="Eneigo.cut">Neisseria gonorrhoeae</option>
+                <option value="Eneucr.cut">Neurospora crassa</option>
+                <option value="Eoncmy.cut">Oncorhynchus mykiss (rainbow trout)</option>
+                <option value="Eorysa.cut">Oryza sativa (rice)</option>
+                <option value="Eorysa_chl.cut">Oryza sativa chloroplast (rice)</option>
+                <option value="Epea.cut">Pisum sativum (pea)</option>
+                <option value="Epethy.cut">Petunia x hybrida</option>
+                <option value="Ephavu.cut">Phaseolus vulgaris</option>
+                <option value="Epig.cut">Sus scrofa (pig)</option>
+                <option value="Eplafa.cut">Plasmodium falciparum 3D7</option>
+                <option value="Eprovu.cut">Proteus vulgaris</option>
+                <option value="Epseae.cut">Pseudomonas aeruginosa PAO1</option>
+                <option value="Epsepu.cut">Pseudomonas putida KT2440</option>
+                <option value="Epsesm.cut">Pseudomonas syringae pv tomato str DC3000</option>
+                <option value="Erabit.cut">Oryctolagus cuniculus (rabbit)</option>
+                <option value="Erat.cut">Rattus norvegicus</option>
+                <option value="Erhile.cut">Rhizobium leguminosarum</option>
+                <option value="Erhime.cut">Sinorhizobium meliloti 1021</option>
+                <option value="Erhoca.cut">Rhodobacter capsulatus</option>
+                <option value="Erhosh.cut">Rhodobacter sphaeroides</option>
+                <option value="Esalsa.cut">Salmo salar (Atlantic salmon)</option>
+                <option value="Esalty.cut">Salmonella typhimurium LT2</option>
+                <option value="Eschma.cut">Schistosoma mansoni</option>
+                <option value="Eschpo.cut">Schizosaccharomyces pombe</option>
+                <option value="Eschpo_cai.cut">Schizosaccharomyces pombe (CAI equivalent)</option>
+                <option value="Eschpo_high.cut">Schizosaccharomyces pombe (high)</option>
+                <option value="Eserma.cut">Serratia marcescens</option>
+                <option value="Esheep.cut">Ovis aries (sheep)</option>
+                <option value="Esoltu.cut">Solanum tuberosum (potato)</option>
+                <option value="Esoybn.cut">Glycine max (soybean)</option>
+                <option value="Espiol.cut">Spinacia oleracea (spinach)</option>
+                <option value="Estaau.cut">Staphylococcus aureus</option>
+                <option value="Estrco.cut">Streptomyces coelicolor A3 2</option>
+                <option value="Estrmu.cut">Streptococcus mutans UA159</option>
+                <option value="Estrpn.cut">Streptococcus pneumoniae R6</option>
+                <option value="Estrpu.cut">Strongylocentrotus purpuratus (sea urchin)</option>
+                <option value="Esv40.cut">Simian Virus 40</option>
+                <option value="Esynco.cut">Synechococcus sp WH 8102</option>
+                <option value="Esyncy.cut">Synechocystis sp PCC 6803</option>
+                <option value="Etetth.cut">Tetrahymena thermophila</option>
+                <option value="Etheth.cut">Thermus thermophilus HB8</option>
+                <option value="Etobac.cut">Nicotiana tabacum (tobacco)</option>
+                <option value="Etobac_chl.cut">Nicotiana tabacum chloroplast (tobacco)</option>
+                <option value="Etrybr.cut">Trypanosoma brucei</option>
+                <option value="Etrycr.cut">Trypanosoma cruzi</option>
+                <option value="Evibch.cut">Vibrio cholerae O1 biovar eltor str N16961</option>
+                <option value="Ewheat.cut">Triticum aestivum (wheat)</option>
+                <option value="Exenla.cut">Xenopus laevis</option>
+                <option value="Eyeast.cut">Saccharomyces cerevisiae</option>
+                <option value="Eyeast_cai.cut">Saccharomyces cerevisiae original CAI set</option>
+                <option value="Eyeast_high.cut">Saccharomyces cerevisiae (high)</option>
+                <option value="Eyeast_mit.cut">Saccharomyces cerevisiae mitochondrion</option>
+                <option value="Eyeren.cut">Yersinia enterocolitica</option>
+            </param>
         </section>
     </inputs>
     <outputs>
@@ -37,13 +161,19 @@
         <test>
         <!-- test 1: check if identical outputs are produced with default parameters  -->
             <param name="genes_file" value="genes_lycopene.csv" />
-            <output name="constructs" file="constructs_lycopene.xml" ftype="xml" compare="sim_size"/>
+            <output name="constructs" >
+                <assert_contents>
+                    <is_valid_xml />
+                    <has_size value="451293" delta="100" />
+                </assert_contents>
+            </output>
         </test>
     </tests>
     <help><![CDATA[
 OptDoE
 ===========
-This tool takes as input a rpSBML file, that contains for each heterologous reaction a ranked list of UniProt identifiers for the sequences, and the list of links to the DNA registry SynBioHub for the desired vector backbones, resistance cassette, and promoters (generated using the tool "OptDoE Parts Reference Generator"). An optimal design of experiments is performed by using OptBioDes based on logistic regression analysis with an assumed linear model for the response. The design is evaluated by its D-efficiency, defined as:
+
+An optimal design of experiments is performed by using OptBioDes based on logistic regression analysis with an assumed linear model for the response. The design is evaluated by its D-efficiency, defined as:
 
 .. math:: D_{eff} = \frac{1}{n}\abs{X^{T}X}^{\frac{1}{p}}
 
@@ -86,26 +216,23 @@
     | Ter     | Terminator | https://synbiohub.org/public/igem/BBa_B1006/1    |
     +---------+------------+--------------------------------------------------+
 	  
-To generate another CSV
+The source of this file can be found here as a model: https://raw.githubusercontent.com/pablocarb/doebase/master/doebase/data/ref_parts.csv
 
 Input
 -----
 
 Required:
 
-* **genes_file**\ : (string) Path to either tar.xz input collection of rpSBML files or a single rpSBML file.
-* **-input_format**\ : (string) Format of the input
-* **-input_sbol**\ : (string) Path to the SBOL input file
-* **-input_parts**\ : (string) CSV with the genetic parts. Default (if left empty) is the above table. To generate a new compatible CSV file, please use the "OptDoE Parts Reference Generator" tool
+* **genes_file**\ : (string) Genes File (csv).
 
 Advanced options:
 
-* **genes_sbol_file**\ : (string) Path to the optimised gens file (SBOL)
+* **genes_sbol_file**\ : (string) SBOL file containing optimised versions of the genes (RBS, etc)
 * **ref_parts_file**\ : (string) CSV with the genetic parts. Default (if left empty) is the above table. To generate a new compatible CSV file, please use the "OptDoE Parts Reference Generator" tool
 * **libsize**\ : (integer, default: 32) Maximal library size 
 * **get_sequences**\ : (boolean, default: True)
 * **backtranslate**\ : (boolean, default: True)
-* **codon_table**\ : (text, default: Eecoli.cut)
+* **codon_table**\ : (text, default: Eecoli.cut) Codon Usage Table. See `codon_table <https://www.ebi.ac.uk/seqdb/confluence/display/JDSAT/EMBOSS+backtranseq+Help+and+Documentation#EMBOSSbacktranseqHelpandDocumentation-WebServices>`_ for more codons.
 
 Output
 ------