annotate picard_ReplaceSamHeader.xml @ 0:5166ed57b1c4 draft

Uploaded version 1.135
author avowinkel
date Mon, 06 Jul 2015 14:46:32 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
1 <tool name="ReplaceSamHeader" id="picard_ReplaceSamHeader" version="1.135">
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
2 <description>replace header in a SAM/BAM dataset</description>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
3 <macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
4 <import>picard_macros.xml</import>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
5 </macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
6 <expand macro="requirements" />
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
7 <command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
8 @java_options@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
9
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
10
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
11 ## Two lines below are due to the fact that picard likes fasta files to have extension .fa
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
12 #set $fasta_file="local_fasta.fa"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
13 ln -s "${inputFile}" "${fasta_file}" &amp;&amp;
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
14
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
15 java -jar \$JAVA_JAR_PATH/picard.jar
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
16 ReplaceSamHeader
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
17
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
18 INPUT="${inputFile}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
19 HEADER="${header}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
20 OUTPUT="${outFile}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
21
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
22 QUIET=true
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
23 VERBOSITY=ERROR
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
24
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
25 </command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
26 <inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
27 <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"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
28 <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"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
29 </inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
30
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
31 <outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
32 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
33 </outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
34
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
35 <tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
36 <test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
37 <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
38 <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
39 <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
40 </test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
41 </tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
42
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
43 <stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
44 <exit_code range="1:" level="fatal"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
45 </stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
46
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
47 <help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
48
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
49 **Purpose**
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
50
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
51 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.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
52 @dataset_collections@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
53
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
54 @description@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
55
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
56 HEADER=File SAM file from which SAMFileHeader will be read. Required.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
57
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
58 @more_info@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
59
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
60 </help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
61 </tool>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
62
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
63