annotate picard_ReplaceSamHeader.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="Replace SAM/BAM Header" id="picard_ReplaceSamHeader" 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 "$inputFile"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
6 -o $outFile
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
7 --header-file $headerFile
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
8 --output-format $outputFormat
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
9 -j "\$JAVA_JAR_PATH/ReplaceSamHeader.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,sam" name="inputFile" type="data" label="SAM/BAM dataset to replace header in (TARGET)"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
14 help="If empty, upload or import a SAM/BAM dataset." />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
15 <param format="bam,sam" name="headerFile" type="data" label="SAM/BAM to reader header from (SOURCE)"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
16 help="If empty, upload or import a SAM/BAM dataset." />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
17 <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output BAM instead of SAM" help="Uncheck for SAM output" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
18 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
19 <outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
20 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: ${outputFormat} with replaced header">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
21 <change_format>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
22 <when input="outputFormat" value="sam" format="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
23 </change_format>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
24 </data>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
25 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
26 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
27 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
28 <!-- Command:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
29 java -jar ReplaceSamHeader.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_input_tiny_coord.bam HEADER=test-data/picard_RSH_input1.bam O=picard_RSH_output1.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
30 picard_RSH_input1.bam can be made from picard_RSH_input1.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
31 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
32 <param name="inputFile" value="picard_input_tiny_coord.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
33 <param name="headerFile" value="picard_RSH_input1.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
34 <param name="outputFormat" value="False" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
35 <output name="outFile" file="picard_RSH_output1.sam" ftype="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
36 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
37 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38 <!-- Command:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
39 java -jar ReplaceSamHeader.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_input_tiny_coord.sam HEADER=test-data/picard_RSH_input1.bam O=picard_RSH_output2.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
40 picard_RSH_input1.bam can be made from picard_RSH_input1.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
41 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42 <param name="inputFile" value="picard_input_tiny_coord.sam" ftype="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
43 <param name="headerFile" value="picard_RSH_input1.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44 <param name="outputFormat" value="False" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 <output name="outFile" file="picard_RSH_output2.sam" ftype="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
48 <!-- Command:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 java -jar ReplaceSamHeader.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_input_tiny_coord.sam HEADER=test-data/picard_RSH_input1.sam O=picard_RSH_output2.bam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51 <param name="inputFile" value="picard_input_tiny_coord.sam" ftype="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52 <param name="headerFile" value="picard_RSH_input1.sam" ftype="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53 <param name="outputFormat" value="True" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54 <output name="outFile" file="picard_RSH_output2.bam" ftype="bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56 </tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
60 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
64 Replace Sam Header with the header from another sam file. The tool does not do any
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
65 significant validation, so it's up to the user to make sure that the elements in
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66 the header are relevant and that the new header has all the required things.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
67
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
68 Replace the SAMFileHeader in a SAM file with the given header. Validation is
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
69 minimal. It is up to the user to ensure that all the elements referred to in the
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
70 SAMRecords are present in the new header. Sort order of the two input files must
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
71 be the same.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
72
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 **Picard documentation**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
75 This is a Galaxy wrapper for ReplaceSamHeader, a part of the external package Picard-tools_.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
76
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
79 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
80
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
81 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
82
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83 **Inputs and outputs**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
84
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
85 Either a sam file or a bam file is required as the file whose header will be replaced.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86 The header file is also required and can also be either sam or bam (it does not have
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
87 to be the same type as the other file). In both cases, if a bam file is used, it must
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
88 be coordinate-sorted. Galaxy currently coordinate-sorts all bam files.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90 The tool will output either bam (the default) or sam. Bam is recommended since it is smaller.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92 .. class:: warningmark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94 **Warning on SAM/BAM quality**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
95
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96 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
97 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
98 to be the only way to deal with SAM/BAM that cannot be parsed.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
99
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
103 </tool>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
104
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106
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