annotate picard_ReplaceSamHeader.xml @ 0:b76a4f17bbbb draft

Uploaded
author devteam
date Thu, 23 Oct 2014 11:31:30 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
1 <tool name="ReplaceSamHeader" id="picard_ReplaceSamHeader" version="1.122.0">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
2 <description>replace header in a SAM/BAM dataset</description>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
3 <requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.122.0">picard</requirement>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
5 </requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
6
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
7 <macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
9 </macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
10
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
11 <command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
12 @java_options@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
13
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
14
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
15 ## Two lines below are due to the fact that picard likes fasta files to have extension .fa
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
16 #set $fasta_file="local_fasta.fa"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
17 ln -s "${inputFile}" "${fasta_file}" &amp;&amp;
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
18
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
19 java -jar \$JAVA_JAR_PATH/ReplaceSamHeader.jar
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
20
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
21 INPUT="${inputFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
22 HEADER="${header}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
23 OUTPUT="${outFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
24
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
25 QUIET=true
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
26 VERBOSITY=ERROR
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
27
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
28 </command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
29 <inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
30 <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection (header recepient dataset)" help="If empty, upload or import a SAM/BAM dataset"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
31 <param name="header" type="data" format="sam,bam" label="SAM/BAM dataset from which Header will be read (header source dataset)" help="HEADER; If empty, upload or import a SAM/BAM dataset"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
32 </inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
33
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
34 <outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
35 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
36 </outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
37
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
38 <tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
39 <test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
40 <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
41 <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
42 <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
43 </test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
44 </tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
45
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
46 <stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
47 <exit_code range="1:" level="fatal"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
48 </stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
49
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
50 <help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
51
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
52 **Purpose**
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
53
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
54 Replace the SAMFileHeader in a SAM/BAM dataset with the given header. Validation is minimal. It is up to the user to ensure that all the elements referred to in the SAMRecords are present in the new header. Sort order of the two input datasets must be the same.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
55 @dataset_collections@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
56
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
57 @description@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
58
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
59 HEADER=File SAM file from which SAMFileHeader will be read. Required.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
60
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
61 @more_info@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
62
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
63 </help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
64 </tool>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
65
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
66