annotate picard_ReplaceSamHeader.xml @ 9:5eaa8a968300 draft

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