annotate quality_filter.xml @ 1:0c48b354dcfe draft default tip

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:28:59 -0400
parents 5da8dce9fd62
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="qualityFilter" name="Filter nucleotides" version="1.0.1">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
2 <description> based on quality scores</description>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.7.1">bx-python</requirement>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
7 <command interpreter="python">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
8 quality_filter.py
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
9 $input
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
10 $out_file1
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
11 $primary_species
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
12 $mask_species
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
13 $score
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
14 $mask_char
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
15 ${mask_region.region}
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
16 #if $mask_region.region == "3"
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
17 ${mask_region.lengthr},${mask_region.lengthl}
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
18 #elif $mask_region.region == "0"
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
19 1
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
20 #else
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
21 ${mask_region.length}
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
22 #end if
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
23 ${GALAXY_DATA_INDEX_DIR}/quality_scores.loc
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
24 </command>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
25 <inputs>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
26 <param format="maf" name="input" type="data" label="Select data"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
27 <param name="primary_species" type="select" label="Use quality scores of" display="checkboxes" multiple="true">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
28 <options>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
29 <filter type="data_meta" ref="input" key="species" />
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
30 </options>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
31 </param>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
32 <param name="mask_species" type="select" label="Mask Species" display="checkboxes" multiple="true">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
33 <options>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
34 <filter type="data_meta" ref="input" key="species" />
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
35 </options>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
36 </param>
1
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
37 <param name="score" type="integer" value="20" label="Quality score cut-off" help="Cut-off value of 20 means mask all nucleotides having quality score less than or equal to 20"/>
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
38 <param name="mask_char" type="select" label="Mask character">
0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
39 <option value="0" selected="true">#</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
40 <option value="1">$</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
41 <option value="2">^</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
42 <option value="3">*</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
43 <option value="4">?</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
44 <option value="5">N</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
45 </param>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
46 <conditional name="mask_region">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
47 <param name="region" type="select" label="Mask region">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
48 <option value="0" selected="true">Only the corresponding nucleotide </option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
49 <option value="1">Corresponding column + right-side neighbors</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
50 <option value="2">Corresponding column + left-side neighbors</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
51 <option value="3">Corresponding column + neighbors on both sides</option>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
52 </param>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
53 <when value="0">
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
54 </when>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
55 <when value="1">
1
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
56 <param name="length" type="integer" value="2" label="Number of right-side neighbors"/>
0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
57 </when>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
58 <when value="2">
1
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
59 <param name="length" type="integer" value="2" label="Number of left-side neighbors"/>
0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
60 </when>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
61 <when value="3">
1
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
62 <param name="lengthr" type="integer" value="2" label="Number of neighbors on right-side" />
0c48b354dcfe planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
63 <param name="lengthl" type="integer" value="2" label="Number of neighbors on left-side" />
0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
64 </when>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
65 </conditional>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
66 </inputs>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
67 <outputs>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
68 <data format="maf" name="out_file1" metadata_source="input"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
69 </outputs>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
70 <requirements>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
71 <requirement type="python-module">numpy</requirement>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
72 </requirements>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
73 <tests>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
74 <test>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
75 <param name="input" value="6.maf"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
76 <param name="primary_species" value="panTro2"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
77 <param name="mask_species" value="hg18"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
78 <param name="score" value="50"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
79 <param name="mask_char" value="0"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
80 <param name="region" value="0" />
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
81 <output name="out_file1" file="6_quality_filter.maf"/>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
82 </test>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
83 </tests>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
84 <help>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
85
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
86 .. class:: infomark
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
87
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
88 **What it does**
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
89
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
90 This tool takes a MAF file as input and filters nucleotides in every alignment block of the MAF file based on their quality/PHRED scores.
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
91
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
92 -----
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
93
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
94 .. class:: warningmark
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
95
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
96 **Note**
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
97
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
98 Any block/s not containing the primary species (species whose quality scores is to be used), will be omitted.
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
99 Also, any primary species whose quality scores are not available in Galaxy will be considered as a non-primary species. This info will appear as a message in the job history panel.
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
100
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
101 -----
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
102
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
103 **Example**
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
104
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
105 - For the following alignment block::
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
106
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
107 a score=4050.0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
108 s hg18.chrX 3719221 48 - 154913754 tattttacatttaaaataaatatgtaaatatatattttatatttaaaa
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
109 s panTro2.chrX 3560945 48 - 155361357 tattttatatttaaaataaagatgtaaatatatattttatatttaaaa
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
110
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
111 - running this tool with **Primary species as panTro2**, **Mask species as hg18, panTro2**, **Quality cutoff as 20**, **Mask character as #** and **Mask region as only the corresponding position** will return::
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
112
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
113 a score=4050.0
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
114 s hg18.chrX 3719221 48 - 154913754 ###tttac#####a###a#atatgtaaat###tattt#####ttaaaa
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
115 s panTro2.chrX 3560945 48 - 155361357 ###tttat#####a###a#agatgtaaat###tattt#####ttaaaa
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
116
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
117 where, the positions containing # represent panTro2 nucleotides having quality scores less than 20.
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
118 </help>
5da8dce9fd62 Imported from capsule None
devteam
parents:
diff changeset
119 </tool>