annotate pe_histogram.xml @ 0:638c1e914099 draft

Uploaded
author iuc
date Mon, 20 Jun 2016 12:59:34 -0400
parents
children d23480305b5a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
638c1e914099 Uploaded
iuc
parents:
diff changeset
1 <tool id="pe_histogram" name="Paired-end histogram" version="1.0.0">
638c1e914099 Uploaded
iuc
parents:
diff changeset
2 <description>of insert size frequency</description>
638c1e914099 Uploaded
iuc
parents:
diff changeset
3 <requirements>
638c1e914099 Uploaded
iuc
parents:
diff changeset
4 <requirement type="package" version="8.0.45">java-jdk</requirement>
638c1e914099 Uploaded
iuc
parents:
diff changeset
5 </requirements>
638c1e914099 Uploaded
iuc
parents:
diff changeset
6 <stdio>
638c1e914099 Uploaded
iuc
parents:
diff changeset
7 <!-- Anything other than zero is an error -->
638c1e914099 Uploaded
iuc
parents:
diff changeset
8 <exit_code range=":-1" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
9 <exit_code range="1:" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
10 <!-- Check stderr in case the return code has not been set -->
638c1e914099 Uploaded
iuc
parents:
diff changeset
11 <regex match="Error:" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
12 <regex match="Exception:" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
13 </stdio>
638c1e914099 Uploaded
iuc
parents:
diff changeset
14 <command>
638c1e914099 Uploaded
iuc
parents:
diff changeset
15 <![CDATA[
638c1e914099 Uploaded
iuc
parents:
diff changeset
16 ln -s "${input_bam}" "localbam.bam" &&
638c1e914099 Uploaded
iuc
parents:
diff changeset
17 ln -f -s "${input_bam.metadata.bam_index}" "localbam.bam.bai" &&
638c1e914099 Uploaded
iuc
parents:
diff changeset
18 java -jar $__tool_directory__/PEHistogram.jar
638c1e914099 Uploaded
iuc
parents:
diff changeset
19 -B "localbam.bam"
638c1e914099 Uploaded
iuc
parents:
diff changeset
20 -I "localbam.bam.bai"
638c1e914099 Uploaded
iuc
parents:
diff changeset
21 #if str($lower_limit) != '':
638c1e914099 Uploaded
iuc
parents:
diff changeset
22 -l $lower_limit
638c1e914099 Uploaded
iuc
parents:
diff changeset
23 #end if
638c1e914099 Uploaded
iuc
parents:
diff changeset
24 #if str($upper_limit) != '':
638c1e914099 Uploaded
iuc
parents:
diff changeset
25 -u $upper_limit
638c1e914099 Uploaded
iuc
parents:
diff changeset
26 #end if
638c1e914099 Uploaded
iuc
parents:
diff changeset
27 -p "$output1"
638c1e914099 Uploaded
iuc
parents:
diff changeset
28 -t "$output2" 1>/dev/null
638c1e914099 Uploaded
iuc
parents:
diff changeset
29 ]]>
638c1e914099 Uploaded
iuc
parents:
diff changeset
30 </command>
638c1e914099 Uploaded
iuc
parents:
diff changeset
31 <inputs>
638c1e914099 Uploaded
iuc
parents:
diff changeset
32 <param name="input_bam" type="data" format="bam" label="BAM file" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
33 <param name="lower_limit" type="integer" value="" optional="True" min="0" label="Lower bp limit (optional)" help="The lower bp limit on insert size for calculating the histogram."/>
638c1e914099 Uploaded
iuc
parents:
diff changeset
34 <param name="upper_limit" type="integer" value="" optional="True" min="0" label="Upper bp limit (optional)" help="The upper bp limit on insert size for calculating the histogram." />
638c1e914099 Uploaded
iuc
parents:
diff changeset
35 </inputs>
638c1e914099 Uploaded
iuc
parents:
diff changeset
36 <outputs>
638c1e914099 Uploaded
iuc
parents:
diff changeset
37 <data name="output1" format="png" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
38 <data name="output2" format="tabular" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
39 </outputs>
638c1e914099 Uploaded
iuc
parents:
diff changeset
40 <tests>
638c1e914099 Uploaded
iuc
parents:
diff changeset
41 <test>
638c1e914099 Uploaded
iuc
parents:
diff changeset
42 <param name="input_bam" value="input.bam" ftype="bam" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
43 <output name="output1" file="output1.png" ftype="png" compare="sim_size" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
44 <output name="output2" file="output1.tabular" ftype="tabular" compare="contains" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
45 </test>
638c1e914099 Uploaded
iuc
parents:
diff changeset
46 <test>
638c1e914099 Uploaded
iuc
parents:
diff changeset
47 <param name="input_bam" value="input.bam" ftype="bam" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
48 <param name="lower_limit" value="200" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
49 <param name="upper_limit" value="300" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
50 <output name="output1" file="output2.png" ftype="png" compare="sim_size" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
51 <output name="output2" file="output2.tabular" ftype="tabular" compare="contains" />
638c1e914099 Uploaded
iuc
parents:
diff changeset
52 </test>
638c1e914099 Uploaded
iuc
parents:
diff changeset
53 </tests>
638c1e914099 Uploaded
iuc
parents:
diff changeset
54 <help>
638c1e914099 Uploaded
iuc
parents:
diff changeset
55
638c1e914099 Uploaded
iuc
parents:
diff changeset
56 **What it does**
638c1e914099 Uploaded
iuc
parents:
diff changeset
57
638c1e914099 Uploaded
iuc
parents:
diff changeset
58 Produces an insert size histogram and basic statistics for a paired-end BAM file. Two outputs are produced:
638c1e914099 Uploaded
iuc
parents:
diff changeset
59
638c1e914099 Uploaded
iuc
parents:
diff changeset
60 - a png image consisting of the histogram of the insert size frequency
638c1e914099 Uploaded
iuc
parents:
diff changeset
61 - a tabular file containing the alignment statistics
638c1e914099 Uploaded
iuc
parents:
diff changeset
62
638c1e914099 Uploaded
iuc
parents:
diff changeset
63 -----
638c1e914099 Uploaded
iuc
parents:
diff changeset
64
638c1e914099 Uploaded
iuc
parents:
diff changeset
65 **Options**
638c1e914099 Uploaded
iuc
parents:
diff changeset
66
638c1e914099 Uploaded
iuc
parents:
diff changeset
67 * **Lower bp limit** - the lower bp limit on insert size for calculating the histogram.
638c1e914099 Uploaded
iuc
parents:
diff changeset
68 * **Upper bp limit** - the upper bp limit on insert size for calculating the histogram.
638c1e914099 Uploaded
iuc
parents:
diff changeset
69
638c1e914099 Uploaded
iuc
parents:
diff changeset
70 </help>
638c1e914099 Uploaded
iuc
parents:
diff changeset
71 <citations>
638c1e914099 Uploaded
iuc
parents:
diff changeset
72 <citation type="bibtex">
638c1e914099 Uploaded
iuc
parents:
diff changeset
73 @unpublished{None,
638c1e914099 Uploaded
iuc
parents:
diff changeset
74 author = {Lai, William},
638c1e914099 Uploaded
iuc
parents:
diff changeset
75 title = {None},
638c1e914099 Uploaded
iuc
parents:
diff changeset
76 year = {None},
638c1e914099 Uploaded
iuc
parents:
diff changeset
77 eprint = {None},
638c1e914099 Uploaded
iuc
parents:
diff changeset
78 url = {http://www.huck.psu.edu/content/research/independent-centers-excellence/center-for-eukaryotic-gene-regulation}
638c1e914099 Uploaded
iuc
parents:
diff changeset
79 }</citation>
638c1e914099 Uploaded
iuc
parents:
diff changeset
80 </citations>
638c1e914099 Uploaded
iuc
parents:
diff changeset
81 </tool>