annotate filter.xml @ 2:ce6db18f5fd3 draft

Uploaded
author bcclaywell
date Thu, 26 Feb 2015 19:31:20 -0500
parents
children 2d023c621bd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
1 <tool id="PHYLO_filter" name="Filter and trim" version="1.3.0">
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
2 <description>sequences</description>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
3 <requirements>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
4 <requirement type="package">yapp_env</requirement>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
5 </requirements>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
6 <macros>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
7 <import>macros.xml</import>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
8 </macros>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
9 <version_command>seqmagick --version</version_command>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
10 <command interpreter="bash">
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
11 filter-wrapper.sh ${config}
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
12 </command>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
13 <stdio>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
14 <expand macro="basic_errors"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
15 </stdio>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
16 <inputs>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
17 <!-- TODO: can take either fasta+qual or fastq -->
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
18 <param name="plate_id" type="integer" value="1" label="Plate number"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
19 <param name="zone_id" type="integer" value="1" label="Zone number"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
20 <param name="raw_seqs" type="data" format="fasta" label="Unfiltered sequences"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
21 <param name="input_qual" type="data" format="qual" label="Sequence quality data"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
22 <!-- TODO: handle MID format for multi-sample sequencing; see http://qiime.org/scripts/split_libraries.html -->
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
23 <param name="barcodes" type="data" format="csv" label="Barcodes"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
24 <param name="primer" type="text" label="Primer" value="GCGGACTACCVGGGTATCTAAT" area="True" size="1x40"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
25 <param name="min_length" type="integer" min="100" max="1000" value="350" label="Minimum sequence length"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
26 <param name="min_quality" type="integer" min="0" max="63" value="35" label="Minimum mean sequence quality"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
27 <param name="reverse_complement" type="boolean" truevalue="TRUE" falsevalue="FALSE" label="Reads uniformly correspond to negative strands"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
28 </inputs>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
29 <outputs>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
30 <data name="filtered_seqs" format="fasta" label="Filtered sequences"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
31 <data name="filter_report" format="tabular" label="Filtering report"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
32 <data name="filter_details" format="data" label="Filtering details"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
33 <data name="split_map" format="csv" label="Read-to-specimen map"/>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
34 </outputs>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
35 <configfiles>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
36 <configfile name="config">
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
37 RAW_SEQS="${raw_seqs}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
38 INPUT_QUAL="${input_qual}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
39 BARCODES="${barcodes}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
40 PRIMER="${primer}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
41 MIN_LENGTH="${min_length}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
42 MIN_QUALITY="${min_quality}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
43 REVERSE_COMPLEMENT="${reverse_complement}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
44
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
45 FILTERED_SEQS="${filtered_seqs}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
46 FILTER_REPORT="${filter_report}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
47 FILTER_DETAILS="${filter_details}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
48 SPLIT_MAP="${split_map}"
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
49 </configfile>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
50 </configfiles>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
51 <!-- The contents of the help tag is parsed as reStructuredText. Please see
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
52 help-template.rst for examples of commonly-used sections in other Galaxy
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
53 tools. -->
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
54 <help>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
55
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
56 .. class:: infomark
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
57
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
58 **What it does**
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
59
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
60 This tool truncates and removes sequences that don’t match a set of quality
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
61 criteria, as well as mapping sequence barcodes to specimens. It takes input
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
62 sequences in FASTA format and a quality file, and outputs the filtered
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
63 sequences as well as a filtering summary.
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
64
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
65 The default quality filter settings are:
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
66
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
67 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
68 |parameter |value |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
69 +===========================+======+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
70 |--min-length |350 |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
71 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
72 |--min-mean-quality |35 |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
73 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
74 |--quality-window |30 |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
75 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
76 |--quality-window-prop |0.9 |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
77 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
78 |--quality-window-mean-qual |15 |
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
79 +---------------------------+------+
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
80
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
81 See seqmagick's `quality filter documentation`_ for full explanations of these
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
82 parameters.
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
83
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
84 .. _quality filter documentation: http://fhcrc.github.io/seqmagick/quality_filter.html
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
85
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
86 </help>
ce6db18f5fd3 Uploaded
bcclaywell
parents:
diff changeset
87 </tool>