annotate picard_CollectWgsMetrics.xml @ 8:3a3234d7a2e8 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
author devteam
date Thu, 16 Jul 2015 15:53:10 -0400
parents 3d4f1fa26f0e
children 05087b27692a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
1 <tool name="CollectWgsMetrics" id="picard_CollectWgsMetrics" version="@TOOL_VERSION@.0">
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>
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: 5
diff changeset
6 <expand macro="requirements" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 ##set up input files
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 #set $reference_fasta_filename = "localref.fa"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 #if str( $reference_source.reference_source_selector ) == "history":
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 #else:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 #end if
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 CollectWgsMetrics
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 REFERENCE_SEQUENCE="${reference_fasta_filename}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 MINIMUM_MAPPING_QUALITY="${minimum_mapping_quality}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 MINIMUM_BASE_QUALITY="${minimum_base_quality}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 COVERAGE_CAP="${coverage_cap}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 <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
35 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <option value="cached">Local cache</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <option value="history">History</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <options from_data_table="all_fasta">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 </options>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <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
45 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <when value="history">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 <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
49 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 </conditional>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <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
52 <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
53 <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
54
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 <data format="tabular" name="outFile" label="${tool.name} on ${on_string}: Summary data"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <param name="minimum_mapping_quality" value="20" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <param name="minimum_base_quality" value="20" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 <param name="coverage_cap" value="250" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <param name="ref_file" value="picard_CollectWgsMetrics_ref.fa" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <param name="inputFile" value="picard_CollectWgsMetrics.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <output name="outFile" file="picard_CollectWgsMetrics_test1.tab" ftype="tabular" lines_diff="4"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 Computes a number of metrics that are useful for evaluating coverage and performance of whole genome sequencing experiments.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
92 MINIMUM_MAPPING_QUALITY=Integer
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93 MQ=Integer Minimum mapping quality for a read to contribute coverage. Default value: 20.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
95 MINIMUM_BASE_QUALITY=Integer
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
96 Q=Integer Minimum base quality for a base to contribute coverage. Default value: 20.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
97
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98 COVERAGE_CAP=Integer
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99 CAP=Integer Treat bases with coverage exceeding this value as if they had coverage at this value.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
100 Default value: 250.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
103
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
106
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107