annotate picard_CollectWgsMetrics.xml @ 21:6f9c0884a3e7 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 78c3dea7dcd0c854fe7e6dc1d2b2349956167661
author iuc
date Tue, 16 Oct 2018 11:49:10 -0400
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="CollectWgsMetrics" id="picard_CollectWgsMetrics" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>compute metrics for evaluating of whole genome sequencing experiments</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 ##set up input files
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 #set $reference_fasta_filename = "localref.fa"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
14
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
15 @handle_reference_source@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
17 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 CollectWgsMetrics
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
19 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 REFERENCE_SEQUENCE="${reference_fasta_filename}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 MINIMUM_MAPPING_QUALITY="${minimum_mapping_quality}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 MINIMUM_BASE_QUALITY="${minimum_base_quality}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 COVERAGE_CAP="${coverage_cap}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
25
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 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
29 @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
30
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
31 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 <param format="sam,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
34 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <option value="cached">Local cache</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <option value="history">History</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <options from_data_table="all_fasta">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 </options>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <when value="history">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <param name="ref_file" type="data" format="fasta" label="Use the folloing dataset as the reference sequence" help="REFERENCE_SEQUENCE; You can upload a FASTA sequence to the history and use it as reference" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 </conditional>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <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"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <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"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <param name="coverage_cap" type="integer" value="250" label="Treat bases with coverage exceeding this value as if they had coverage at this value" help="COVERAGE_CAP; default=250"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
54
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 <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
56
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 </inputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
58
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 <data format="tabular" name="outFile" label="${tool.name} on ${on_string}: Summary data"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
62
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <param name="minimum_mapping_quality" value="20" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <param name="minimum_base_quality" value="20" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <param name="coverage_cap" value="250" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 <param name="ref_file" value="picard_CollectWgsMetrics_ref.fa" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <param name="inputFile" value="picard_CollectWgsMetrics.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <output name="outFile" file="picard_CollectWgsMetrics_test1.tab" ftype="tabular" lines_diff="4"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
72 </test>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
74
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
75
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 Computes a number of metrics that are useful for evaluating coverage and performance of whole genome sequencing experiments.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88 MINIMUM_MAPPING_QUALITY=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
89 MQ=Integer Minimum mapping quality for a read to contribute coverage. Default value: 20.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91 MINIMUM_BASE_QUALITY=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
92 Q=Integer Minimum base quality for a base to contribute coverage. Default value: 20.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94 COVERAGE_CAP=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
95 CAP=Integer Treat bases with coverage exceeding this value as if they had coverage at this value.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
96 Default value: 250.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
97
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
100 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
101 <expand macro="citations" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102 </tool>