annotate picard_ReplaceSamHeader.xml @ 33:3f254c5ced1d draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
author iuc
date Sun, 03 Mar 2024 16:06:11 +0000
parents f9242e01365a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
1 <tool name="ReplaceSamHeader" id="picard_ReplaceSamHeader" version="@TOOL_VERSION@.@WRAPPER_VERSION@" profile="@PROFILE@">
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>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
5 <token name="@WRAPPER_VERSION@">0</token>
28
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>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
10 <expand macro="requirements"/>
28
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"
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
17 ln -sf '${inputFile}' '${fasta_file}' &&
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
18
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
19 picard ReplaceSamHeader
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
20
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
21 --INPUT '$escaped_element_identifier'
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
22 --HEADER '${header}'
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
23 --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
24
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
25 --QUIET true
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
26 --VERBOSITY ERROR
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
27
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
28 ]]></command>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
29 <inputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
30 <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"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
31 <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"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
32 </inputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
33 <outputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
34 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
35 </outputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
36 <tests>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
37 <test>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
38 <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
39 <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
40 <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
41 </test>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
42 </tests>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
43 <help>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
47 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
48 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
50 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
52 HEADER=File SAM file from which SAMFileHeader will be read. Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
54 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56 </help>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
57 <expand macro="citations"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58 </tool>