annotate picard_ReplaceSamHeader.xml @ 24:b9fbec5ac6b2 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9c268f08be6d363990a822fc941e031dd13be3f4
author iuc
date Fri, 31 May 2019 03:21:52 -0400
parents 2a17c789e0a5
children 881d7645d1bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
1 <tool name="ReplaceSamHeader" id="picard_ReplaceSamHeader" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
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>
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
6 </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
7 <expand macro="requirements" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
9 @java_options@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
10 @symlink_element_identifier@
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
11
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
12 ## Two lines below are due to the fact that picard likes fasta files to have extension .fa
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
13 #set $fasta_file="local_fasta.fa"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
14 ln -s "${inputFile}" "${fasta_file}" &&
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
15
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
16 picard
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
17 ReplaceSamHeader
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
18
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
19 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
20 HEADER="${header}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
21 OUTPUT="${outFile}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
22
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
23 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
24 VERBOSITY=ERROR
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
25 @TMPDIR_OPTION@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
26
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
27 ]]></command>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
28 <inputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
29 <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
30 <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"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
31 </inputs>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
32
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
33 <outputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
34 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
35 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
36
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
37 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38 <test>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
39 <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
40 <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
41 <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
43 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
44
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
45
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
48 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
50 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
51 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
53 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
55 HEADER=File SAM file from which SAMFileHeader will be read. Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
57 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
60 <expand macro="citations" />
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61 </tool>