annotate picard_AddOrReplaceReadGroups.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="AddOrReplaceReadGroups" id="picard_AddOrReplaceReadGroups" version="@TOOL_VERSION@.@WRAPPER_VERSION@" profile="@PROFILE@">
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
2 <description>add or replaces read group information</description>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
3 <macros>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
4 <import>picard_macros.xml</import>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
5 <import>read_group_macros.xml</import>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
6 <token name="@WRAPPER_VERSION@">0</token>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
7 </macros>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
8 <expand macro="requirements"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
10 @define_read_group_helpers@
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
11 #set $rg_auto_name = $read_group_name_default($inputFile)
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
12 @set_read_group_vars@
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
13 @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
14 @symlink_element_identifier@
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
15 picard AddOrReplaceReadGroups
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
16 --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
17 $format_read_group("", $rg_lb, quote='"', arg=" --RGLB ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
18 $format_read_group("", $rg_pl, quote='"', arg=" --RGPL ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
19 $format_read_group("", $rg_pu, quote='"', arg=" --RGPU ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
20 $format_read_group("", $rg_sm, quote='"', arg=" --RGSM ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
21 $format_read_group("", $rg_id, quote='"', arg=" --RGID ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
22 $format_read_group("", $rg_ds, quote='"', arg=" --RGDS ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
23 $format_read_group("", $rg_pi, quote='"', arg=" --RGPI ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
24 $format_read_group("", $rg_dt, quote='"', arg=" --RGDT ")
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
25 --OUTPUT '${outFile}'
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
26 --VALIDATION_STRINGENCY '${validation_stringency}'
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
27 --QUIET true
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
28 --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
29
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
30 ]]></command>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
31 <inputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
32 <param format="bam,sam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" 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
33 <expand macro="read_group_inputs_picard"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
34 <expand macro="VS"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
35 </inputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
36 <outputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
37 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: BAM with replaced/modified readgroups"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
38 </outputs>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
39 <tests>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
40 <test>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
41 <param name="inputFile" value="picard_ARRG.bam"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
42 <param name="LB" value="tumor-a"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
43 <param name="PL" value="ILLUMINA"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
44 <param name="PU" value="run-1"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
45 <param name="SM" value="sample-a"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
46 <param name="ID" value="id-1"/>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
47 <output name="outFile" file="picard_ARRG_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
48 </test>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
49 </tests>
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
50 <help>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56 Add or Replace Read Groups in an input BAM or SAM file.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
58 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
60 @RG@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
62 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
64 INPUT=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
65 I=File Input file (bam or sam). Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
67 OUTPUT=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
68 O=File Output file (bam or sam). Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
69
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
70 SORT_ORDER=SortOrder
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
71 SO=SortOrder Optional sort order to output in. If not supplied OUTPUT is in the same order as INPUT.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
72 Default value: null. Possible values: {unsorted, queryname, coordinate}
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
74 RGID=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
75 ID=String Read Group ID Default value: 1. This option can be set to 'null' to clear the default
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
76 value.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
78 RGLB=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
79 LB=String Read Group Library Required.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
80
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
81 RGPL=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
82 PL=String Read Group platform (e.g. illumina, solid) Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
84 RGPU=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
85 PU=String Read Group platform unit (eg. run barcode) Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
87 RGSM=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
88 SM=String Read Group sample name Required.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
90 RGCN=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
91 CN=String Read Group sequencing center name Default value: null.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
93 RGDS=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
94 DS=String Read Group description Default value: null.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
95
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
96 RGDT=Iso8601Date
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
97 DT=Iso8601Date Read Group run date Default value: null.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
99 RGPI=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
100 PI=Integer Read Group predicted insert size Default value: null.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
102 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
103 </help>
33
3f254c5ced1d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 9ecbbb878d68a980ba35a90865e524c723ca3ed8
iuc
parents: 32
diff changeset
104 <expand macro="citations"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105 </tool>