annotate picard_FilterSamReads.xml @ 6:4ff1e04010e6 draft

Uploaded
author devteam
date Thu, 15 Jan 2015 15:37:04 -0500
parents 3d4f1fa26f0e
children 3a3234d7a2e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
1 <tool name="FilterSamReads" id="picard_FilterSamReads" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>include or exclude aligned and unaligned reads and read lists</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.126.0">picard</requirement>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 </macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 ##Sam Sorting is performed here because FilterSamReads requires input to be in query-sorted order
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 SortSam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 OUTPUT=query_sorted_bam.bam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 SORT_ORDER=queryname
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 VALIDATION_STRINGENCY=LENIENT
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 &amp;&amp;
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 FilterSamReads
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 INPUT=query_sorted_bam.bam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 FILTER="${filter_type.filter}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 #if ( str( $filter_type.filter ) == "includeReadList" or str( $filter_type.filter ) == "excludeReadList" ):
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 READ_LIST_FILE="${filter_type.read_list_file}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 #end if
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 SORT_ORDER=coordinate
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <param name="inputFile" multiple="True" type="data" format="sam,bam" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <conditional name="filter_type">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <param name="filter" type="select" label="Select filtering type" help="FILTER; see Help for deatiled info">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <option value="includeAligned">Include aligned</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 <option value="excludeAligned">Exclude aligned</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <option value="includeReadList">Include read list</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <option value="excludeReadList">Exclude read list</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <when value="includeAligned"/> <!-- do nothing -->
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <when value="excludeAligned"/> <!-- do nothing -->
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 <when value="includeReadList">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 <param name="read_list_file" type="data" format="tabular" label="Dataset containing read names that will be INCLUDED in the output" help="READ_LIST_FILE"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 <when value="excludeReadList">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 <param name="read_list_file" type="data" format="tabular" label="Dataset containing read names that will be EXCLUDED in the output" help="READ_LIST_FILE"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 </conditional>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: filtered BAM"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <param name="inputFile" value="picard_FilterSamReads.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 <param name="filter" value="includeReadList"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 <param name="read_list_file" value="picard_FilterSamReads_read_list_file.tab" ftype="tabular"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 <param name="validation_stringency" value="LENIENT"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <output name="outFile" file="picard_FilterSamReads_include_reads_test1.bam" ftype="bam" lines_diff="2"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 <param name="inputFile" value="picard_FilterSamReads.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 <param name="filter" value="excludeReadList"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81 <param name="read_list_file" value="picard_FilterSamReads_read_list_file.tab" ftype="tabular"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 <param name="validation_stringency" value="LENIENT"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 <output name="outFile" file="picard_FilterSamReads_exclude_reads_test2.bam" ftype="bam" lines_diff="2"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
92
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
95 Computes a number of metrics that are useful for evaluating coverage and performance of whole genome sequencing experiments.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
96
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
97 ------
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99 .. class:: warningmark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
100
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101 **Warning on using this tool on BWA-MEM output**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
103 This tool will likely fail on BAM datasets generated by BWA MEM as it generates partial read alignemnts.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
106
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
108
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
109 FILTER=Filter Filter. Required. Possible values:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
110 includeAligned [OUTPUT SAM/BAM will contain aligned
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
111 reads only. (Note that *both* first and
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
112 second of paired reads must be aligned to be included
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
113 in the OUTPUT SAM or BAM)],
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
114
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
115 excludeAligned [OUTPUT SAM/BAM will contain un-mapped reads only.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
116 (Note that *both* first and second of pair must be aligned to be
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
117 excluded from the OUTPUT SAM or BAM)]
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
118
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
119 includeReadList [OUTPUT SAM/BAM will contain reads
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
120 that are supplied in the READ_LIST_FILE file]
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
121
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
122 excludeReadList [OUTPUT bam will contain
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
123 reads that are *not* supplied in the READ_LIST_FILE file]}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
124
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
125 READ_LIST_FILE=File
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
126 RLF=File Read List File containing reads that will be included or excluded from the OUTPUT SAM or
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
127 BAM file. Default value: null.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
128
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
129 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
130
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
131 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
132 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
133
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
134