annotate nanofilt.xml @ 0:ff1cc05e789a draft

planemo upload
author leomrtns
date Tue, 14 May 2019 05:57:15 -0400
parents
children a2c318b04f49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
1 <tool id="nanofilt" name="NanoFilt" version="0.1.0">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
2 <description>Filtering and trimming of long read sequencing data</description>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
3 <requirements>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
4 <requirement type="package" version="2.3.0">nanofilt</requirement>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
5 </requirements>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
7 NanoFilt
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
8 #if str($filter.quality) != ""
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
9 -q ${filter.quality}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
10 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
11 #if str($filter.minlength) != ""
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
12 --length ${filter.minlength}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
13 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
14 #if str($filter.maxlength) != ""
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
15 --maxlength ${filter.maxlength}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
16 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
17 #if str($crop.head) != ""
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
18 --headcrop ${crop.head}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
19 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
20 #if str($crop.tail) != ""
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
21 --tailcrop ${crop.tail}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
22 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
23 #if $summary.selector
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
24 --readtype "${summary.readtype}"
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
25 --summary "${summary.summary_file}"
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
26 #end if
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
27 --logfile $logfile
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
28 "$input1" > "$output1"
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
29 ]]></command>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
30 <inputs>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
31 <param type="data" name="input1" format="fastqsanger" label="uncompressed fastq file" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
32 <section name="filter" title="Options for filtering reads based on length or quality">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
33 <param name="quality" type="integer" label="Filter on a minimum average read quality score" value="30" min="0" max="255" help="(-q)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
34 <param name="maxlength" type="integer" label="Filter on a maximum read length" help="(--maxlength)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
35 <param name="minlength" type="integer" label="Filter on a minimum read length" help="(--length)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
36 </section>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
37 <section name="crop" title="Options for trimming reads">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
38 <param name="head" type="integer" label="Trim n nucleotides from start of read" help="(--headcrop)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
39 <param name="tail" type="integer" label="Trim n nucleotides from end of read" help="(--tailcrop)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
40 </section>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
41 <conditional name="summary">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
42 <param name="selector" type="boolean" checked="false" label="Use albacore or guppy summary file for quality scores"/>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
43 <when value="true">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
44 <param type="data" name="summary_file" format="tabular" label="Summary file generated by albacore or guppy."/>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
45 <param name="readtype" argument="--readtype" type="select" label="Which read type to extract information about from summary">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
46 <option value="1D" selected="true">1D</option>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
47 <option value="2D">2D</option>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
48 <option value="1D2">1D2</option>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
49 </param>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
50 </when>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
51 <when value="false">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
52 <param name="minGC" type="float" label="Sequences must have GC content higher than this" min="0.0" max="1.0" help="(--minGC)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
53 <param name="maxGC" type="float" label="Sequences must have GC content lower than this" min="0.0" max="1.0" help="(--maxGC)" optional="true" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
54 </when>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
55 </conditional>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
56 </inputs>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
57 <outputs>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
58 <data name="output1" format="fastq" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
59 <data name="logfile" format="tabular" label="Log file" from_work_dir="logfile.txt" />
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
60 </outputs>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
61 <tests>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
62 <test>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
63 <param name="input1" value="input.fastq"/>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
64 <output name="output1" file="output.fastq"/>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
65 </test>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
66 </tests>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
67 <help><![CDATA[
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
68 usage: NanoFilt [-h] [-v] [--logfile LOGFILE] [-l LENGTH] [--maxlength MAXLENGTH]
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
69 [-q QUALITY] [--minGC MINGC] [--maxGC MAXGC] [--headcrop HEADCROP] [--tailcrop TAILCROP]
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
70 [-s SUMMARY] [--readtype {1D,2D,1D2}]
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
71
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
72 Perform quality and/or length and/or GC filtering of (long read) fastq data. Reads on stdin.
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
73
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
74 EXAMPLES:
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
75
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
76 gunzip -c reads.fastq.gz | NanoFilt -q 10 -l 500 --headcrop 50 | minimap2 genome.fa - | samtools sort -O BAM -@24 -o alignment.bam -
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
77
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
78 gunzip -c reads.fastq.gz | NanoFilt -q 12 --headcrop 75 | gzip > trimmed-reads.fastq.gz
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
79
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
80
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
81 ]]></help>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
82 <citations>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
83 <citation type="bibtex">
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
84 @misc{githubnanofilt,
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
85 title = {nanofilt},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
86 publisher = {GitHub},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
87 journal = {GitHub repository},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
88 url = {https://github.com/wdecoster/nanofilt}
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
89 }
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
90 @article{10.1093/bioinformatics/bty149,
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
91 author = {De Coster, Wouter and D’Hert, Svenn and Schultz, Darrin T and Cruts, Marc and Van Broeckhoven, Christine},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
92 title = "{NanoPack: visualizing and processing long-read sequencing data}",
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
93 journal = {Bioinformatics},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
94 volume = {34},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
95 number = {15},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
96 pages = {2666-2669},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
97 year = {2018},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
98 month = {03},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
99 abstract = "{Here we describe NanoPack, a set of tools developed for visualization and processing of long-read sequencing data from Oxford Nanopore Technologies and Pacific Biosciences.The NanoPack tools are written in Python3 and released under the GNU GPL3.0 License. The source code can be found at https://github.com/wdecoster/nanopack, together with links to separate scripts and their documentation. The scripts are compatible with Linux, Mac OS and the MS Windows 10 subsystem for Linux and are available as a graphical user interface, a web service at http://nanoplot.bioinf.be and command line tools.Supplementary data are available at Bioinformatics online.}",
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
100 issn = {1367-4803},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
101 doi = {10.1093/bioinformatics/bty149},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
102 url = {https://doi.org/10.1093/bioinformatics/bty149},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
103 eprint = {http://oup.prod.sis.lan/bioinformatics/article-pdf/34/15/2666/25230836/bty149.pdf},
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
104 }
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
105 </citation>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
106 </citations>
ff1cc05e789a planemo upload
leomrtns
parents:
diff changeset
107 </tool>