diff mash_sketch.xml @ 0:70e20e8ccdaf draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit b1e065ba7e15f9f10b969db1d561b0e8fe6d4572-dirty"
author dfornika
date Fri, 14 Feb 2020 18:56:53 +0000
parents
children ca04184270ba
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mash_sketch.xml	Fri Feb 14 18:56:53 2020 +0000
@@ -0,0 +1,110 @@
+<tool id="mash_sketch" name="mash sketch" version="@TOOL_VERSION@+galaxy0" profile="19.01">
+    <description>
+        Create a reduced representation of a sequence or set of sequences, based on min-hashes.
+    </description>
+    <macros>
+        <import>macros.xml</import>
+    </macros>
+    <requirements>
+        <requirement type="package" version="@TOOL_VERSION@">mash</requirement>
+    </requirements>
+    <version_command>mash --version</version_command>
+    <command detect_errors="exit_code"><![CDATA[
+        mash sketch
+            -s '${sketch_size}'
+            -k '${kmer_size}'
+            -m '${minimum_kmer_copies}'
+            #if str ( $reads_assembly.reads_assembly_selector ) == "reads"
+              -r
+              #if str( $reads_assembly.reads_input.reads_input_selector ) == "paired"
+                '$reads_input.reads_1' '$reads_input.reads_2'
+              #end if
+              #if str( $reads_assembly.reads_input.reads_input_selector ) == "paired_collection"
+                '$reads_assembly.reads_input.reads.forward' '$reads_assembly.reads_input.reads.reverse'
+              #end if
+              #if str( $reads_assembly.reads_input.reads_input_selector ) == "single"
+                '$reads_assembly.reads_input.reads'
+              #end if
+            #elif str ( $reads_assembly.reads_assembly_selector ) == "assembly"
+              '${assembly}'
+              ${reads_assembly.individual_sequences}
+            #end if
+            -o 'sketch'
+    ]]></command>
+    <inputs>
+        <conditional name="reads_assembly">
+            <param name="reads_assembly_selector" type="select" label="Input: Reads or Assemblies">
+                <option selected="True" value="reads">Reads</option>
+                <option value="assembly">Assembly</option>
+            </param>
+            <when value="reads">
+                <conditional name="reads_input">
+                    <param name="reads_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
+                        <option value="paired">Paired</option>
+                        <option value="single">Single</option>
+                        <option value="paired_collection">Paired Collection</option>
+                    </param>
+                    <when value="paired">
+                        <param name="reads_1" type="data" format="@INTYPES@" label="Select first set of reads" help="Specify dataset with forward reads"/>
+                        <param name="reads_2" type="data" format="@INTYPES@" label="Select second set of reads" help="Specify dataset with reverse reads"/>
+                    </when>
+                    <when value="single">
+                        <param name="reads" type="data" format="@INTYPES@" label="Select fastq dataset" help="Specify dataset with single reads"/>
+                    </when>
+                    <when value="paired_collection">
+                        <param name="reads" format="@INTYPES@" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
+                    </when>
+                </conditional>
+            </when>
+            <when value="assembly">
+                <param name="assembly" type="data" format="fasta,fasta.gz" label="Assembly"/>
+                <param type="boolean" name="individual_sequences" truevalue="-i" falsevalue="" label="Sketch individual Sequences"/> 
+            </when>
+        </conditional>
+        <param type="integer" name="sketch_size" argument="-s" value="1000" min="10" max="1000000" />
+        <param type="integer" name="kmer_size" argument="-k" value="21" min="1" max="32"/>
+        <param type="integer" name="minimum_kmer_copies" argument="-m" value="1" min="1" max="1000"/>
+    </inputs>
+    <outputs>
+        <data name="sketch" format="msh" from_work_dir="sketch.msh"/>
+    </outputs>
+    <tests>
+        <test>
+            <param name="reads_assembly_selector" value="reads" />
+            <param name="reads_input_selector" value="single"/>
+            <param name="reads" value="ERR024951_seqtk_sample_1000_1.fastq"/>
+            <output name="sketch" file="ERR024951_seqtk_sample_1000_1.sketch.msh" compare="sim_size" />
+        </test>
+        <test>
+            <param name="reads_assembly_selector" value="assembly" />
+            <param name="assembly" value="test_assembly.fasta"/>
+            <output name="sketch" file="test_assembly.sketch.msh" compare="sim_size" />
+        </test>
+    </tests>
+    <help><![CDATA[
+Description:
+
+  Create a sketch file, which is a reduced representation of a sequence or set
+  of sequences (based on min-hashes) that can be used for fast distance
+  estimations. Inputs can be fasta or fastq files (gzipped or not), and "-" can
+  be given to read from standard input. Input files can also be files of file
+  names (see -l). For output, one sketch file will be generated, but it can have
+  multiple sketches within it, divided by sequences or files (see -i). By
+  default, the output file name will be the first input file with a '.msh'
+  extension, or 'stdin.msh' if standard input is used (see -o).
+  ]]></help>
+    <citations>
+        <citation type="bibtex">
+            @article{ondov2016mash,
+                title={Mash: fast genome and metagenome distance estimation using MinHash},
+                author={Ondov, Brian D and Treangen, Todd J and Melsted, P{\'a}ll and Mallonee, Adam B and Bergman, Nicholas H and Koren, Sergey and Phillippy, Adam M},
+                journal={Genome biology},
+                volume={17},
+                number={1},
+                pages={132},
+                year={2016},
+                publisher={BioMed Central}
+            }
+        </citation>
+    </citations>
+</tool>