annotate picard_CollectInsertSizeMetrics.xml @ 9:5eaa8a968300 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
author devteam
date Fri, 09 Oct 2015 17:43:13 -0400
parents 3a3234d7a2e8
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="CollectInsertSizeMetrics" id="picard_CollectInsertSizeMetrics" version="@TOOL_VERSION@.0">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>plots distribution of insert sizes</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">
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
7 <requirement type="package" version="3.1.2">R</requirement>
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
8 </expand>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10 @java_options@
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"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 #if str( $reference_source.reference_source_selector ) == "history":
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 #else:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 #end if
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 CollectInsertSizeMetrics
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 HISTOGRAM_FILE="${histFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 DEVIATIONS="${deviations}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 #if str( $hist_width ):
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 HISTOGRAM_WIDTH="${hist_width}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 #end if
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 MINIMUM_PCT="${min_pct}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 REFERENCE_SEQUENCE="${reference_fasta_filename}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 ASSUME_SORTED="${assume_sorted}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 METRIC_ACCUMULATION_LEVEL="${metric_accumulation_level}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <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
44 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <option value="cached">Local cache</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <option value="history">History</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <options from_data_table="all_fasta">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 </options>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <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
54 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 <when value="history">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 <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
58 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 </conditional>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 <param name="deviations" type="float" value="10.0" label="Generate mean, sd and plots by trimming the data down to MEDIAN + DEVIATIONS*MEDIAN_ABSOLUTE_DEVIATION" help="DEVIATIONS; This option is offered because insert size data typically includes enough anomalous values from chimeras and other artifacts to make the mean and SD grossly misleading regarding the real distribution. default=10.0"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 <param name="hist_width" type="integer" optional="True" label="Explicitly sets the Histogram width, overriding automatic truncation of Histogram tail" help="HISTOGRAM_WIDTH; optional"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 <param name="min_pct" type="float" value="0.05" label="When generating the Histogram, discard any data categories (out of FR, TANDEM, RF) that have fewer than this percentage of overall reads" help="MINIMUM_PCT; (Range: 0 to 1). default=0.05. "/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 <param name="metric_accumulation_level" type="select" label="The level(s) at which to accumulate metrics" multiple="true" help="METRIC_ACCUMULATION_LEVEL">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 <option value="ALL_READS" selected="True">All reads</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <option value="SAMPLE">Sample</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <option value="LIBRARY">Library</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <option value="READ_GROUP">Read group</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <data format="tabular" name="outFile"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 <data format="pdf" name="histFile"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 <param name="metric_accumulation_level" value="ALL_READS"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 <param name="deviations" value="10.0" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 <param name="hist_width" value="500" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85 <param name="min_pct" value="0.05" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 <param name="assume_sorted" value="true" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88 <param name="ref_file" value="picard_CollectInsertSizeMetrics_ref.fa" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89 <param name="inputFile" value="picard_CollectInsertSizeMetrics.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90 <output name="outFile" file="picard_CollectInsertSizeMetrics_test1.tab" ftype="tabular" lines_diff="4"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
92 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
95 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
96 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
97
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
100 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
103
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104 Reads a SAM or BAM dataset and writes a file containing metrics about the statistical distribution of insert size (excluding duplicates) and generates a Histogram plot.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
106 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
108 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
109
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
110
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
111 DEVIATIONS=Double Generate mean, sd and plots by trimming the data down to MEDIAN +
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
112 DEVIATIONS*MEDIAN_ABSOLUTE_DEVIATION. This is done because insert size data typically
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
113 includes enough anomalous values from chimeras and other artifacts to make the mean and
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
114 sd grossly misleading regarding the real distribution. Default value: 10.0.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
115
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
116 HISTOGRAM_WIDTH=Integer
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
117 W=Integer Explicitly sets the Histogram width, overriding automatic truncation of Histogram tail.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
118 Also, when calculating mean and standard deviation, only bins &lt;= Histogram_WIDTH will be
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
119 included. Default value: not set.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
120
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
121 MINIMUM_PCT=Float
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
122 M=Float When generating the Histogram, discard any data categories (out of FR, TANDEM, RF) that
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
123 have fewer than this percentage of overall reads. (Range: 0 to 1). Default value: 0.05.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
124
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
125 METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
126 LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE,
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
127 LIBRARY, READ_GROUP} This option may be specified 0 or more times.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
128
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
129 ASSUME_SORTED=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
130 AS=Boolean If true (default), then the sort order in the header file will be ignored. Default
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
131 value: true. This option can be set to 'null' to clear the default value. Possible
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
132 values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
133
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
134 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
135
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
136 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
137 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
138
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
139