Mercurial > repos > devteam > picard

annotate picard_MarkDuplicates.xml @ 18:7615ac66c6e5 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 3ce5dea3af8f4816b4a83914b53402aa84e08fca
author iuc
date Sat, 20 Jan 2018 08:28:24 -0500
parents fc288950c3b7
children 5053a18d9bc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
1 <tool name="MarkDuplicates" id="picard_MarkDuplicates" version="@TOOL_VERSION@.2">
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>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </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
6 <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
7 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 @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
9 @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
10 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 MarkDuplicates
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
12
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
13 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
14 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
15
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
16 METRICS_FILE='${metrics_file}'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 #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
18 COMMENT='${element.comment}'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 #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
20
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
21 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
22 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
23
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
24 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
25
6
4ff1e04010e6 Uploaded
devteam
parents: 5
diff changeset
26 #import pipes
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:
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
28 READ_NAME_REGEX=${ pipes.quote( str( $read_name_regex ) ) }
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 # Optional arguments
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
33 #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
34 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
35 #end if
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
36
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
37 VALIDATION_STRINGENCY='${validation_stringency}'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 VERBOSITY=ERROR
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
40
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
41 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <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
44 <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
45 <param name="comment" type="text" label="Add this comment to BAM dataset"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 </repeat>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <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
48 <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
49
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <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
51 <option value="SUM_OF_BASE_QUALITIES">SUM_OF_BASE_QUALITIES</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <option value="TOTAL_MAPPED_REFERENCE_LENGTH">TOTAL_MAPPED_REFERENCE_LENGTH</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
55 <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)">
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
56
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 <sanitizer>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 <valid initial="string.printable">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 </valid>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 </sanitizer>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 <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
63
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
64 <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."/>
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
65
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <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
67
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
68 </inputs>
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
69
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <data format="txt" name="metrics_file" label="${tool.name} on ${on_string}: MarkDuplicate metrics"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: MarkDuplicates BAM output"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 </outputs>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
74
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 <param name="inputFile" value="picard_MarkDuplicates.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 <param name="comment" value="test-run"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 <param name="assume_sorted" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 <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
81 <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
82 <param name="optical_duplicate_pixel_distance" value="100"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 <param name="duplicate_scoring_strategy" value="SUM_OF_BASE_QUALITIES"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 <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
85 <output name="outFile" file="picard_MarkDuplicates_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 </test>
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
87 <test>
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="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
89 <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
90 <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
91 <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
92 <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
93 <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
94 <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
95 <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
96 <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
97 </test>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98 </tests>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
99
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
100
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
103 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105 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
106
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
108
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
109 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
110
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
111 COMMENT=String
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
112 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
113 more times.
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
114
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
115 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
116 appropriate flags set. Default value: false.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
117
18
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
118 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
119 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
120 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
121 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
122 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
123 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
124 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
125 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
126 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
127 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
128 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
129 are assumed to be tile, x and y values. Default value: ''
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
130
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
131
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
132 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
133 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
134 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
135
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
136 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
137 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
138 duplicates. This should be set to 100 for (circa 2011+) read names and typical flowcells.
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
139 Structured flow cells (NovaSeq, HiSeq 4000, X) should use ~2500.
7615ac66c6e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
iuc
parents: 17
diff changeset
140 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
141 Default value: 100.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
142
17
fc288950c3b7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit a55cff7dfc145ed17ec2ee9f6a70d51c6f9d74b6
iuc
parents: 14
diff changeset
143 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
144
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
145 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
146
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
147 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
148 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
149
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
150