annotate bbduk.xml @ 5:5127e62d11fb draft default tip

"planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
author thanhlv
date Wed, 18 Mar 2020 21:24:20 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
1 <tool id="bbmap_bbduk" name="bbduk" version="@VERSION@">
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
2 <description> Compares reads to the kmers in a reference dataset, optionally
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
3 allowing an edit distance</description>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
4 <macros>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
5 <import>macros.xml</import>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
6 </macros>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
7 <expand macro="requirements" />
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
8 <expand macro="version_command" />
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
9
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
11 bbduk.sh
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
12 in1=${reads[0]}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
13 in2=${reads[1]}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
14 ref=${bbduk_adapters}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
15 out1=${pair_id}_1.trimmed.fastq.gz
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
16 out2=${pair_id}_2.trimmed.fastq.gz
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
17 stats=${pair_id}.stats.txt
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
18 threads=${task.cpus}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
19 minlen=${params.bbduk_minlen}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
20 qtrim=${params.bbduk_qtrim}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
21 trimq=${params.bbduk_trimq}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
22 ktrim=${params.bbduk_ktrim}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
23 k=${params.bbduk_k}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
24 mink=${params.bbduk_mink}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
25 hdist=${params.bbduk_hdist}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
26 ${params.bbduk_trimbyoverlap}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
27 ${params.bbduk_trimpairsevenly}
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
28 ]]> </command>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
29
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
30 <inputs>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
31 <param name="ref" type="data" format="fasta,fasta.gz" label="Reference assembly"/>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
32 <param name="reads" type="data" format="fastq,fastq.gz" label="Long reads"/>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
33 </inputs>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
34
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
35 <outputs>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
36 <data name="assembly" format="fasta" />
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
37 </outputs>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
38 <help><![CDATA[
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
39 “Duk” stands for Decontamination Using Kmers. BBDuk was developed to combine most common data-quality-related trimming, filtering, and masking operations into a single high-performance tool. It is capable of quality-trimming and filtering, adapter-trimming, contaminant-filtering via kmer matching, sequence masking, GC-filtering, length filtering, entropy-filtering, format conversion, histogram generation, subsampling, quality-score recalibration, kmer cardinality estimation, and various other operations in a single pass. Specifically, any combination of operations is possible in a single pass, with the exception of kmer-based operations (kmer trimming, kmer masking, or kmer filtering); at most 1 kmer-based operation can be done in a single pass. BBDuk2 allows multiple kmer-based operations in a single pass, and is otherwise equivalent to BBDuk.
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
40
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
41 BBDuk’s parameters are described in its shellscript (bbduk.sh). This file provides usage examples of various common tasks.
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
42 ]]> </help>
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
43 <expand macro="citations" />
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
44
5127e62d11fb "planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/bbmap commit f832310ee25935e283f72f057790af7fad0d661b-dirty"
thanhlv
parents:
diff changeset
45 </tool>