annotate picard_FilterSamReads.xml @ 28:881d7645d1bf draft

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