annotate picard_BamIndexStats.xml @ 1:e0232cbac965

Uploaded
author devteam
date Thu, 25 Oct 2012 12:51:42 -0400
parents 1cd7f3b42609
children 9227b8c3093b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
1 <tool name="BAM Index Statistics" id="picard_BamIndexStats" version="1.56.0">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
2 <requirements><requirement type="package" version="1.56.0">picard</requirement></requirements>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
3 <command interpreter="python">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
4 picard_wrapper.py
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
5 --input "$input_file"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
6 --bai-file "$input_file.metadata.bam_index"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
7 -t "$htmlfile"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
8 -d "$htmlfile.files_path"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
9 -j "\$JAVA_JAR_PATH/BamIndexStats.jar"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
10 --tmpdir "${__new_file_path__}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
11 </command>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
12 <inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
13 <param format="bam" name="input_file" type="data" label="BAM dataset to generate statistics for"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
14 help="If empty, upload or import a BAM dataset" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
15 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
16 <outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
17 <data format="html" name="htmlfile" label="${tool.name}_on_${on_string}.html" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
18 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
19 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
20 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
21 <!-- Command
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
22 java -jar BamIndexStats.jar I=test-data/picard_input_tiny_coord.bam > picard_BIS_output1.txt
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
23 picard_input_tiny_coord.bam can be created from picard_input_tiny_coord.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
24 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
25 <param name="input_file" value="picard_input_tiny_coord.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
26 <output name="htmlfile" file="picard_BIS_output1.txt" ftype="html" compare="contains" lines_diff="12"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
27 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
28 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
29 <!-- Command
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
30 java -jar BamIndexStats.jar I=test-data/picard_BIS_input1.bam > picard_BIS_output2.txt
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
31 picard_BIS_input1.bam can be created from picard_BIS_input1.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
32 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
33 <param name="input_file" value="picard_BIS_input1.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
34 <output name="htmlfile" file="picard_BIS_output2.txt" ftype="html" compare="contains" lines_diff="12" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
35 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
36 </tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
37 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
39 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
40
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
41 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
43 Generate Bam Index Stats for a provided BAM file.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 **Picard documentation**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47 This is a Galaxy wrapper for BamIndexStats, a part of the external package Picard-tools_.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
48
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55 **Inputs and outputs**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57 The only input is the BAM file you wish to obtain statistics for, which is required.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58 Note that it must be coordinate-sorted. Galaxy currently coordinate-sorts all BAM files.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
60 This tool outputs an HTML file that contains links to the actual metrics results, as well
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61 as a log file with info on the exact command run.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63 .. class:: warningmark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
64
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
65 **Warning on SAM/BAM quality**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
67 Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
68 flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
69 to be the only way to deal with SAM/BAM that cannot be parsed.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
70
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
71 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
72
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 **Example**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
75 Given a BAM file created from the following::
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
76
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77 @HD VN:1.0 SO:coordinate
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78 @SQ SN:chr1 LN:101
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
79 @SQ SN:chr7 LN:404
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
80 @SQ SN:chr8 LN:202
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
81 @SQ SN:chr10 LN:303
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
82 @SQ SN:chr14 LN:505
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83 @RG ID:0 SM:Hi,Mom!
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
84 @RG ID:1 SM:samplesample DS:ClearDescription
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
85 @PG ID:1 PN:Hey! VN:2.0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86 @CO Just a generic comment to make the header longer
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
87 read1 83 chr7 1 255 101M = 302 201 CAACAGAAGCNGGNATCTGTGTTTGTGTTTCGGATTTCCTGCTGAANNGNTTNTCGNNTCNNNNNNNNATCCCGATTTCNTTCCGCAGCTNACCTCCCAAN )'.*.+2,))II'I*/)-I*-)I.-)I)I),/-II..)./.,.).*II,I.II-)III0*IIIIIIII/32/,01460II/6/*0*/2/283//36868/I RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
88 read2 89 chr7 1 255 101M * 0 0 CAACAGAAGCNGGNATCTGTGTTTGTGTTTCGGATTTCCTGCTGAANNGNTTNTCGNNTCNNNNNNNNATCCCGATTTCNTTCCGCAGCTNACCTCCCAAN )'.*.+2,))II'I*/)-I*-)I.-)I)I),/-II..)./.,.).*II,I.II-)III0*IIIIIIII/32/,01460II/6/*0*/2/283//36868/I RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89 read3 83 chr7 1 255 101M = 302 201 CAACAGAAGCNGGNATCTGTGTTTGTGTTTCGGATTTCCTGCTGAANNGNTTNTCGNNTCNNNNNNNNATCCCGATTTCNTTCCGCAGCTNACCTCCCAAN )'.*.+2,))II'I*/)-I*-)I.-)I)I),/-II..)./.,.).*II,I.II-)III0*IIIIIIII/32/,01460II/6/*0*/2/283//36868/I RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90 read4 147 chr7 16 255 101M = 21 -96 CAACAGAAGCNGGNATCTGTGTTTGTGTTTCGGATTTCCTGCTGAANNGNTTNTCGNNTCNNNNNNNNATCCCGATTTCNTTCCGCAGCTNACCTCCCAAN )'.*.+2,))II'I*/)-I*-)I.-)I)I),/-II..)./.,.).*II,I.II-)III0*IIIIIIII/32/,01460II/6/*0*/2/283//36868/I RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91 read5 99 chr7 21 255 101M = 16 96 CAACAGAAGCNGGNATCTGTGTTTGTGTTTCGGATTTCCTGCTGAANNGNTTNTCGNNTCNNNNNNNNATCCCGATTTCNTTCCGCAGCTNACCTCCCAAN )'.*.+2,))II'I*/)-I*-)I.-)I)I),/-II..)./.,.).*II,I.II-)III0*IIIIIIII/32/,01460II/6/*0*/2/283//36868/I RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92 read6 163 chr7 302 255 101M = 1 -201 NCGCGGCATCNCGATTTCTTTCCGCAGCTAACCTCCCGACAGATCGGCAGCGCGTCGTGTAGGTTATTATGGTACATCTTGTCGTGCGGCNAGAGCATACA I/15445666651/566666553+2/14/I/555512+3/)-'/-I-'*+))*''13+3)'//++''/'))/3+I*5++)I'2+I+/*I-II*)I-./1'1 RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93 read7 163 chr7 302 255 10M1D10M5I76M = 1 -201 NCGCGGCATCNCGATTTCTTTCCGCAGCTAACCTCCCGACAGATCGGCAGCGCGTCGTGTAGGTTATTATGGTACATCTTGTCGTGCGGCNAGAGCATACA I/15445666651/566666553+2/14/I/555512+3/)-'/-I-'*+))*''13+3)'//++''/'))/3+I*5++)I'2+I+/*I-II*)I-./1'1 RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94 read8 165 * 0 0 * chr7 1 0 NCGCGGCATCNCGATTTCTTTCCGCAGCTAACCTCCCGACAGATCGGCAGCGCGTCGTGTAGGTTATTATGGTACATCTTGTCGTGCGGCNAGAGCATACA I/15445666651/566666553+2/14/I/555512+3/)-'/-I-'*+))*''13+3)'//++''/'))/3+I*5++)I'2+I+/*I-II*)I-./1'1 RG:Z:0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
95
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96 The following metrics file will be produced::
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
97
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98 chr1 length= 101 Aligned= 0 Unaligned= 0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
99 chr7 length= 404 Aligned= 7 Unaligned= 0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100 chr8 length= 202 Aligned= 0 Unaligned= 0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101 chr10 length= 303 Aligned= 0 Unaligned= 0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102 chr14 length= 505 Aligned= 0 Unaligned= 0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
103 NoCoordinateCount= 1
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
104
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106 </tool>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
107
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
108
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
109
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
110
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
111
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
112
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
113
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
114
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
115
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
117
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118