annotate picard_FilterSamReads.xml @ 0:5166ed57b1c4 draft

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