Mercurial > repos > devteam > picard

annotate picard_CollectHsMetrics.xml @ 28:c943f4a04af0 draft default tip

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 285fab1660daa944d6833ae1e059b30cb1e88309
author iuc
date Mon, 25 Sep 2023 08:31:14 +0000
parents 862298bf72d7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
2 <tool name="CollectHsMetrics" id="picard_CollectHsMetrics" version="@TOOL_VERSION@">
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
3 <description>compute metrics about datasets generated through hybrid-selection (e.g. exome)</description>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
4 <macros>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
5 <import>picard_macros.xml</import>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
6 </macros>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
7 <expand macro="requirements" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
9 @java_options@
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
10 @symlink_element_identifier@
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
11
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
12 picard
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
13 CollectHsMetrics
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
14 INPUT='$escaped_element_identifier'
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
15 OUTPUT='${outFile}'
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
16 MINIMUM_MAPPING_QUALITY=${minimum_mapping_quality}
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
17 MINIMUM_BASE_QUALITY=${minimum_base_quality}
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
18 COVERAGE_CAP=${coverage_cap}
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
19 CLIP_OVERLAPPING_READS=${clip_overlapping_reads}
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
20 BAIT_INTERVALS='${baitFile}'
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
21 TARGET_INTERVALS='${targetFile}'
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
22 VALIDATION_STRINGENCY=${validation_stringency}
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
23 QUIET=true
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
24 VERBOSITY=ERROR
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
25 ]]></command>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
26 <inputs>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
27 <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" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
28 <param name="baitFile" type="data" format="picard_interval_list" label="An interval list file that contains the locations of the baits used" help="If empty, upload or convert from BED" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
29 <param name="targetFile" type="data" format="picard_interval_list" label="An interval list file that contains the locations of the targets" help="If empty, upload or convert from BED" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
30 <param name="minimum_mapping_quality" type="integer" value="20" label="Minimum mapping quality for a read to contribute coverage" help="MINIMUM_MAPPING_QUALITY; default=20" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
31 <param name="minimum_base_quality" type="integer" value="20" label="Minimum base quality for a base to contribute coverage" help="MINIMUM_BASE_QUALITY; default=20" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
32 <param name="coverage_cap" type="integer" value="200" label="Treat bases with coverage exceeding this value as if they had coverage at this value" help="COVERAGE_CAP; default=200" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
33 <param name="clip_overlapping_reads" type="boolean" label="Clip overlapping reads" checked="true" truevalue="true" falsevalue="false" help="CLIP_OVERLAPPING_READS; default=true" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
34 <expand macro="VS" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
35 </inputs>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
36 <outputs>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
37 <data name="outFile" format="txt" label="${tool.name} on ${on_string}: Summary data" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
38 </outputs>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
39 <tests>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
40 <test>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
41 <param name="inputFile" value="picard_CollectHsMetrics.bam" ftype="bam" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
42 <param name="baitFile" value="picard_CollectHsMetrics.baits" ftype="picard_interval_list" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
43 <param name="targetFile" value="picard_CollectHsMetrics.target" ftype="picard_interval_list" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
44 <param name="minimum_mapping_quality" value="20" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
45 <param name="minimum_base_quality" value="20" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
46 <param name="coverage_cap" value="200" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
47 <param name="clip_overlapping_reads" value="true" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
48 <output name="outFile" file="picard_CollectHsMetrics_test1.tab" lines_diff="6" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
49 </test>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
50 </tests>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
51 <help><![CDATA[
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
52 .. class:: infomark
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
53
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
54 **Purpose**
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
55
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
56 Computes a number of metrics that are useful for evaluating coverage and performance of datasets generated through hybrid-selection.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
57 Hybrid-selection (HS) is the most commonly used technique to capture exon-specific sequences for targeted sequencing experiments
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
58 such as exome sequencing.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
59
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
60 @dataset_collections@
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
61
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
62 -----
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
63
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
64 .. class:: warningmark
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
65
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
66 **Obtaining bait and target interval files in Picard interval_list format**
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
67
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
68 This tool requires an aligned SAM or BAM file as well as bait and target interval files in Picard interval_list format.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
69 You should use the bait and interval files that correspond to the capture kit that was used to generate the capture libraries
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
70 for sequencing, which can generally be obtained from the kit manufacturer.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
71 If the baits and target intervals are provided in BED format, you can convert them to the Picard interval_list format
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
72 using Picard's **BedToIntervalList** tool, which will also add the required SAM style header.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
73
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
74 @description@
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
75
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
76 MINIMUM_MAPPING_QUALITY=Integer
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
77 MQ=Integer Minimum mapping quality for a read to contribute coverage. Default value: 20.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
78
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
79 MINIMUM_BASE_QUALITY=Integer
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
80 Q=Integer Minimum base quality for a base to contribute coverage. Default value: 20.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
81
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
82 COVERAGE_CAP=Integer
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
83 CAP=Integer Treat bases with coverage exceeding this value as if they had coverage at this value.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
84 Default value: 200.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
85 CLIP_OVERLAPPING_READS=Boolean
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
86 If true, clip overlapping reads, false otherwise. Default value: true.
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
87
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
88 @more_info@
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
89 ]]></help>
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
90 <expand macro="citations" />
862298bf72d7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
iuc
parents:
diff changeset
91 </tool>