Mercurial > repos > devteam > picard

comparison picard_AddOrReplaceReadGroups.xml @ 0:1cd7f3b42609

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded tool.
author devteam
date Tue, 23 Oct 2012 13:14:29 -0400
parents
children 9227b8c3093b
comparison
equal deleted inserted replaced
-1:000000000000 0:1cd7f3b42609
1 <tool name="Add or Replace Groups" id="picard_ARRG" version="1.56.0">
2 <requirements><requirement type="package" version="1.56.0">picard</requirement></requirements>
3 <command interpreter="python">
4 picard_wrapper.py
5 --input="$inputFile"
6 --rg-lb="$rglb"
7 --rg-pl="$rgpl"
8 --rg-pu="$rgpu"
9 --rg-sm="$rgsm"
10 --rg-id="$rgid"
11 --rg-opts=${readGroupOpts.rgOpts}
12 #if $readGroupOpts.rgOpts == "full"
13 --rg-cn="$readGroupOpts.rgcn"
14 --rg-ds="$readGroupOpts.rgds"
15 #end if
16 --output-format=$outputFormat
17 --output=$outFile
18 -j "\$JAVA_JAR_PATH/AddOrReplaceReadGroups.jar"
19 --tmpdir "${__new_file_path__}"
20 </command>
21 <inputs>
22 <param format="bam,sam" name="inputFile" type="data" label="SAM/BAM dataset to add or replace read groups in"
23 help="If empty, upload or import a SAM/BAM dataset." />
24 <param name="rgid" value="1" type="text" label="Read group ID (ID tag)" help="The most important read group tag. Galaxy will use a value of '1' if nothing provided." />
25 <param name="rgsm" value="" type="text" label="Read group sample name (SM tag)" />
26 <param name="rglb" value="" type="text" label="Read group library (LB tag)" />
27 <param name="rgpl" value="" type="text" label="Read group platform (PL tag)" help="illumina, solid, 454, pacbio, helicos" />
28 <param name="rgpu" value="" type="text" label="Read group platform unit" help="like run barcode, etc." />
29 <conditional name="readGroupOpts">
30 <param name="rgOpts" type="select" label="Specify additional (optional) arguments" help="Allows you to set RGCN and RGDS.">
31 <option value="preSet">Use pre-set defaults</option>
32 <option value="full">Set optional arguments</option>
33 </param>
34 <when value="preSet" />
35 <when value="full">
36 <param name="rgcn" value="" type="text" label="Read group sequencing center name" help="Leave set to &lt;null&gt; for default (none)" />
37 <param name="rgds" value="" type="text" label="Read group description" help="Leave set to &lt;null&gt; for default (none)" />
38 </when>
39 </conditional>
40 <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output bam instead of sam" help="Uncheck for sam output" />
41 </inputs>
42 <outputs>
43 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: ${outputFormat} with read groups replaced">
44 <change_format>
45 <when input="outputFormat" value="sam" format="sam" />
46 </change_format>
47 </data>
48 </outputs>
49 <tests>
50 <test>
51 <!-- Command for replacing read groups in bam:
52 java -jar AddOrReplaceReadGroups.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_ARRG_input1.bam O=picard_ARRG_output1.sam RGID=one RGLB=lib RGPL=illumina RGPU=peaewe RGSM=sam1
53 -->
54 <param name="inputFile" value="picard_ARRG_input1.bam" />
55 <param name="rglb" value="lib" />
56 <param name="rgpl" value="illumina" />
57 <param name="rgpu" value="peaewe" />
58 <param name="rgsm" value="sam1" />
59 <param name="rgid" value="one" />
60 <param name="rgOpts" value="preSet" />
61 <param name="outputFormat" value="False" />
62 <output name="outFile" file="picard_ARRG_output1.sam" ftype="sam" />
63 </test>
64 <test>
65 <!-- Command for replacing read groups in sam:
66 java -jar AddOrReplaceReadGroups.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_ARRG_input1.sam O=picard_ARRG_output2.sam RGLB=LIB RGPL=IL RGPU=PLAT RGSM=smp RGID=M5 RGCN=FamousCenter RGDS="description with spaces"
67 picard_ARRG_input1.bam can be created from picard_ARRG_input1.sam
68 -->
69 <param name="inputFile" value="picard_ARRG_input1.sam" />
70 <param name="rglb" value="LIB" />
71 <param name="rgpl" value="IL" />
72 <param name="rgpu" value="PLAT" />
73 <param name="rgsm" value="smp" />
74 <param name="rgid" value="M5" />
75 <param name="rgOpts" value="full" />
76 <param name="rgcn" value="FamousCenter" />
77 <param name="rgds" value="description with spaces" />
78 <param name="outputFormat" value="False" />
79 <output name="outFile" file="picard_ARRG_output2.sam" ftype="sam" />
80 </test>
81 <test>
82 <!-- Command for adding read groups in sam:
83 java -jar AddOrReplaceReadGroups.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_ARRG_input2.sam O=picard_ARRG_output3.bam RGID=M6 RGLB=LIB RGPL=IL RGPU=PLAT RGSM=smp1
84 -->
85 <param name="inputFile" value="picard_ARRG_input2.sam" />
86 <param name="rglb" value="LIB" />
87 <param name="rgpl" value="IL" />
88 <param name="rgpu" value="PLAT" />
89 <param name="rgsm" value="smp1" />
90 <param name="rgid" value="M6" />
91 <param name="rgOpts" value="preSet" />
92 <param name="outputFormat" value="True" />
93 <output name="outFile" file="picard_ARRG_output3.bam" ftype="bam" />
94 </test>
95 </tests>
96 <help>
97
98 .. class:: infomark
99
100 **Purpose**
101
102 Add or Replace Read Groups in an input BAM or SAM file.
103
104 **Read Groups are Important!**
105
106 Many downstream analysis tools (such as GATK, for example) require BAM datasets to contain read groups. Even if you are not going to use GATK, setting read groups correctly from the start will simplify your life greatly. Below we provide an explanation of read groups fields taken from GATK FAQ webpage:
107
108 .. csv-table::
109 :header-rows: 1
110
111 Tag,Importance,Definition,Meaning
112 "ID","Required","Read group identifier. Each @RG line must have a unique ID. The value of ID is used in the RG tags of alignment records. Must be unique among all read groups in header section. Read group IDs may be modified when merging SAM files in order to handle collisions.","Ideally, this should be a globally unique identify across all sequencing data in the world, such as the Illumina flowcell + lane name and number. Will be referenced by each read with the RG:Z field, allowing tools to determine the read group information associated with each read, including the sample from which the read came. Also, a read group is effectively treated as a separate run of the NGS instrument in tools like base quality score recalibration (a GATK component) -- all reads within a read group are assumed to come from the same instrument run and to therefore share the same error model."
113 "SM","Sample. Use pool name where a pool is being sequenced.","Required. As important as ID.","The name of the sample sequenced in this read group. GATK tools treat all read groups with the same SM value as containing sequencing data for the same sample. Therefore it's critical that the SM field be correctly specified, especially when using multi-sample tools like the Unified Genotyper (a GATK component)."
114 "PL","Platform/technology used to produce the read. Valid values: ILLUMINA, SOLID, LS454, HELICOS and PACBIO.","Important. Not currently used in the GATK, but was in the past, and may return. The only way to known the sequencing technology used to generate the sequencing data","It's a good idea to use this field."
115 "LB","DNA preparation library identify","Essential for MarkDuplicates","MarkDuplicates uses the LB field to determine which read groups might contain molecular duplicates, in case the same DNA library was sequenced on multiple lanes."
116
117 **Example of Read Group usage**
118
119 Support we have a trio of samples: MOM, DAD, and KID. Each has two DNA libraries prepared, one with 400 bp inserts and another with 200 bp inserts. Each of these libraries is run on two lanes of an illumina hiseq, requiring 3 x 2 x 2 = 12 lanes of data. When the data come off the sequencer, we would create 12 BAM files, with the following @RG fields in the header::
120
121 Dad's data:
122 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
123 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
124 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
125 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
126
127 Mom's data:
128 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
129 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
130 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
131 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
132
133 Kid's data:
134 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
135 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
136 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
137 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
138
139 Note the hierarchical relationship between read groups (unique for each lane) to libraries (sequenced on two lanes) and samples (across four lanes, two lanes for each library).
140
141 **Picard documentation**
142
143 This is a Galaxy wrapper for AddOrReplaceReadGroups, a part of the external package Picard-tools_.
144
145 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
146
147 ------
148
149 .. class:: infomark
150
151 **Inputs, outputs, and parameters**
152
153 Either a sam file or a bam file must be supplied. If a bam file is used, it must
154 be coordinate-sorted. Galaxy currently coordinate-sorts all bam files.
155
156 The output file is either bam (the default) or sam, according to user selection,
157 and contains the same information as the input file except for the appropraite
158 additional (or modified) read group tags. Bam is recommended since it is smaller.
159
160 From the Picard documentation.
161
162 AddOrReplaceReadGroups REQUIRED parameters::
163
164 Option (Type) Description
165
166 RGLB=String Read Group Library
167 RGPL=String Read Group platform (e.g. illumina, solid)
168 RGPU=String Read Group platform unit (eg. run barcode)
169 RGSM=String Read Group sample name
170 RGID=String Read Group ID; Default value: null (empty)
171
172 AddOrReplaceReadGroups OPTIONAL parameters::
173
174 Option (Type) Description
175
176 RGCN=String Read Group sequencing center name; Default value: null (empty)
177 RGDS=String Read Group description Default value: null (empty)
178
179 One parameter that Picard's AddOrReplaceReadGroups offers that is automatically
180 set by Galaxy is the SORT_ORDER, which is set to coordinate.
181
182 .. class:: warningmark
183
184 **Warning on SAM/BAM quality**
185
186 Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT**
187 flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
188 to be the only way to deal with SAM/BAM that cannot be parsed.
189
190
191
192 </help>
193 </tool>
194
195
196
197
198
199
200
201
202
203
204
205