Mercurial > repos > devteam > picard

annotate picard_MarkDuplicates.xml @ 28:881d7645d1bf draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"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 7d34178f2812
children 585027e65f3b
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: 18
diff changeset
1 <tool name="MarkDuplicates" id="picard_MarkDuplicates" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>examine aligned records in BAM datasets to locate duplicate molecules</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <import>picard_macros.xml</import>
28
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 25
diff changeset
5 <token name="@WRAPPER_VERSION@">3</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: 6
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: 9
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@
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
11 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 MarkDuplicates
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
13
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
14 INPUT='$escaped_element_identifier'
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
15 OUTPUT='${outFile}'
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
16
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
17 METRICS_FILE='${metrics_file}'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 #for $element in $comments:
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
19 COMMENT='${element.comment}'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 #end for
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
21
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
22 REMOVE_DUPLICATES='${remove_duplicates}'
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
23 ASSUME_SORTED='${assume_sorted}'
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
24
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
25 DUPLICATE_SCORING_STRATEGY='${duplicate_scoring_strategy}'
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
26
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
27 #if $read_name_regex:
21
6f9c0884a3e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 78c3dea7dcd0c854fe7e6dc1d2b2349956167661
iuc
parents: 20
diff changeset
28 READ_NAME_REGEX='${ str( $read_name_regex ) }'
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
29 #end if
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
30 OPTICAL_DUPLICATE_PIXEL_DISTANCE='${optical_duplicate_pixel_distance}'
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
31
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
32 #if $barcode_tag:
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
33 BARCODE_TAG='${barcode_tag}'
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
34 #end if
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
35
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
36 VALIDATION_STRINGENCY='${validation_stringency}'
28
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 25
diff changeset
37 TAGGING_POLICY=All
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 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
40 @TMPDIR_OPTION@
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
41
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
42 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <param format="bam" name="inputFile" type="data" 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 <repeat name="comments" title="Comment" min="0" help="You can provide multiple comments">
9
5eaa8a968300 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 8
diff changeset
46 <param name="comment" type="text" label="Add this comment to BAM dataset"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 </repeat>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 <param name="remove_duplicates" type="boolean" label="If true do not write duplicates to the output file instead of writing them with appropriate flags set" help="REMOVE_DUPLICATES; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <param name="duplicate_scoring_strategy" type="select" label="The scoring strategy for choosing the non-duplicate among candidates" help="DUPLICATE_SCORING_STRATEGY; default=SUM_OF_BASE_QUALITIES">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <option value="SUM_OF_BASE_QUALITIES">SUM_OF_BASE_QUALITIES</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <option value="TOTAL_MAPPED_REFERENCE_LENGTH">TOTAL_MAPPED_REFERENCE_LENGTH</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
56 <param name="read_name_regex" type="text" value="" label="Regular expression that can be used in unusual situations to parse non-standard read names in the incoming SAM/BAM dataset" help="READ_NAME_REGEX; Read names are parsed to extract three variables: tile/region, x coordinate and y coordinate. These values are used to estimate the rate of optical duplication in order to give a more accurate estimated library size. See help below for more info; default='' (uses : separation)">
21
6f9c0884a3e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 78c3dea7dcd0c854fe7e6dc1d2b2349956167661
iuc
parents: 20
diff changeset
57 <expand macro="sanitize_query" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 <param name="optical_duplicate_pixel_distance" type="integer" value="100" min="0" max="500" label="The maximum offset between two duplicte clusters in order to consider them optical duplicates" help="OPTICAL_DUPLICATE_PIXEL_DISTANCE; default=100"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60
25
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
61 <param name="barcode_tag" type="text" optional="True" label="Barcode Tag" help="Barcode SAM tag. This tag can be utilized when you have data from an assay that includes Unique Molecular Indices. Typically 'RX' "/>
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
62
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 <expand macro="VS" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
64
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
65 </inputs>
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
66
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <data format="txt" name="metrics_file" label="${tool.name} on ${on_string}: MarkDuplicate metrics"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: MarkDuplicates BAM output"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 </outputs>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
71
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 <param name="inputFile" value="picard_MarkDuplicates.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 <param name="comment" value="test-run"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <param name="assume_sorted" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 <param name="remove_duplicates" value="True"/>
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
78 <param name="read_name_regex" value=".*[a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 <param name="optical_duplicate_pixel_distance" value="100"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 <param name="duplicate_scoring_strategy" value="SUM_OF_BASE_QUALITIES"/>
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: 9
diff changeset
82 <output name="outFile" file="picard_MarkDuplicates_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 </test>
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
84 <test>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
85 <param name="inputFile" value="picard_MarkDuplicates.bam" ftype="bam"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
86 <param name="comment" value="test-run"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
87 <param name="assume_sorted" value="True"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
88 <param name="remove_duplicates" value="False"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
89 <param name="read_name_regex" value=""/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
90 <param name="optical_duplicate_pixel_distance" value="100"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
91 <param name="duplicate_scoring_strategy" value="SUM_OF_BASE_QUALITIES"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
92 <param name="validation_stringency" value="LENIENT"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
93 <output name="outFile" file="picard_MarkDuplicates_test2.bam" ftype="bam" lines_diff="4"/>
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
94 </test>
25
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
95 <test>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
96 <param name="inputFile" value="picard_MarkDuplicates.bam" ftype="bam"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
97 <param name="comment" value="test-run"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
98 <param name="assume_sorted" value="True"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
99 <param name="remove_duplicates" value="False"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
100 <param name="read_name_regex" value=""/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
101 <param name="optical_duplicate_pixel_distance" value="100"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
102 <param name="duplicate_scoring_strategy" value="SUM_OF_BASE_QUALITIES"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
103 <param name="validation_stringency" value="LENIENT"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
104 <param name='barcode_tag' value="RX"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
105 <output name="outFile" file="picard_MarkDuplicates_test2.bam" ftype="bam" lines_diff="4"/>
7d34178f2812 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a0fcbda330469051d130fd0802c55960ae948e3b
iuc
parents: 21
diff changeset
106 </test>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107 </tests>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
108
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
109
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
110 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
111
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
112 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
113
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
114 Examines aligned records in the supplied SAM or BAM dataset to locate duplicate molecules. All records are then written to the output file with the duplicate records flagged.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
115
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
116 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
117
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
118 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
119
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
120 COMMENT=String
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
121 CO=String Comment(s) to include in the output file's header. This option may be specified 0 or
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
122 more times.
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
123
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
124 REMOVE_DUPLICATES=Boolean If true do not write duplicates to the output file instead of writing them with
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
125 appropriate flags set. Default value: false.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
126
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
127 READ_NAME_REGEX=String This option is only needed if your read names do not follow a standard illumina convention
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
128 of colon separation but do contain tile, x, and y coordinates (unusual).
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
129 A regular expression that can be used to parse read names in the incoming SAM file. Read
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
130 names are parsed to extract three variables: tile/region, x coordinate and y coordinate.
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
131 These values are used to estimate the rate of optical duplication in order to give a more
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
132 accurate estimated library size. Set this option to null to disable optical duplicate
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
133 detection. The regular expression should contain three capture groups for the three
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
134 variables, in order. It must match the entire read name. Note that if the default regex
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
135 is specified, a regex match is not actually done, but instead the read name is split on
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
136 colon character. For 5 element names, the 3rd, 4th and 5th elements are assumed to be
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
137 tile, x and y values. For 7 element names (CASAVA 1.8), the 5th, 6th, and 7th elements
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
138 are assumed to be tile, x and y values. Default value: ''
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 18
diff changeset
139
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
140
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
141 DUPLICATE_SCORING_STRATEGY=ScoringStrategy
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
142 DS=ScoringStrategy The scoring strategy for choosing the non-duplicate among candidates. Default value:
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
143 SUM_OF_BASE_QUALITIES. Possible values: {SUM_OF_BASE_QUALITIES, TOTAL_MAPPED_REFERENCE_LENGTH}
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
144
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
145 OPTICAL_DUPLICATE_PIXEL_DISTANCE=Integer
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
146 The maximum offset between two duplicate clusters in order to consider them optical
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
147 duplicates. This should be set to 100 for (circa 2011+) read names and typical flowcells.
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 18
diff changeset
148 Structured flow cells (NovaSeq, HiSeq 4000, X) should use ~2500.
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
149 For older conventions, distances could be to some fairly small number (e.g. 5-10 pixels)
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
150 Default value: 100.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
151
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
152 BARCODE_TAG=String Barcode SAM tag (ex. BC for 10X Genomics) Default value: null.
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
153
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
154 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
155
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
156 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 18
diff changeset
157 <expand macro="citations" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
158 </tool>