annotate picard_ReplaceSamHeader.xml @ 29:1aac2a13842a draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 1ef1c65fa4d78e1332411af1999862d5a8f28125"
author iuc
date Sun, 20 Mar 2022 14:06:40 +0000
parents 881d7645d1bf
children f9242e01365a
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@">
28
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
2 <description>replace header in a SAM/BAM dataset</description>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
3 <macros>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
4 <import>picard_macros.xml</import>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
6 </macros>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
7 <xrefs>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
8 <xref type="bio.tools">picard_replacesamheader</xref>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
9 </xrefs>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
10 <expand macro="requirements" />
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
12 @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
13 @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
14
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
15 ## 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
16 #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
17 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
18
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
19 picard
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
20 ReplaceSamHeader
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
21
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
22 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
23 HEADER="${header}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
24 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
25
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
26 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
27 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
28 @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
29
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
30 ]]></command>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
31 <inputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
32 <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
33 <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
34 </inputs>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
35
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
36 <outputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
37 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
39
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
40 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
41 <test>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
42 <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
43 <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
44 <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
47
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
48
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
53 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
54 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
56 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
58 HEADER=File SAM file from which SAMFileHeader will be read. Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
60 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
63 <expand macro="citations" />
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
64 </tool>