annotate picard_ReplaceSamHeader.xml @ 5:3d4f1fa26f0e draft

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