PageRenderTime 27ms CodeModel.GetById 17ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/tools/picard/picard_AddOrReplaceReadGroups.xml

https://bitbucket.org/cistrome/cistrome-harvard/
XML | 204 lines | 147 code | 47 blank | 10 comment | 0 complexity | 0acbe6729d71ed6100e82bfdae0a3b9e MD5 | raw file
  1<tool name="Add or Replace Groups" id="picard_ARRG" version="0.2.0">
  2  <requirements><requirement type="package">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 "${GALAXY_DATA_INDEX_DIR}/shared/jars/AddOrReplaceReadGroups.jar"
 19  </command>
 20  <inputs>
 21    <param format="bam,sam" name="inputFile" type="data" label="SAM/BAM dataset to add or replace read groups in"
 22      help="If empty, upload or import a SAM/BAM dataset." />
 23    <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." />
 24    <param name="rgsm" value="" type="text" label="Read group sample name (SM tag)" />
 25    <param name="rglb" value="" type="text" label="Read group library (LB tag)" />
 26    <param name="rgpl" value="" type="text" label="Read group platform (PL tag)" help="illumina, solid, 454, pacbio, helicos" />
 27    <param name="rgpu" value="" type="text" label="Read group platform unit" help="like run barcode, etc." />
 28    <conditional name="readGroupOpts">
 29      <param name="rgOpts" type="select" label="Specify additional (optional) arguments" help="Allows you to set RGCN and RGDS.">
 30        <option value="preSet">Use pre-set defaults</option>
 31        <option value="full">Set optional arguments</option>
 32      </param>
 33      <when value="preSet" />
 34      <when value="full">
 35        <param name="rgcn" value="" type="text" label="Read group sequencing center name" help="Leave set to &lt;null&gt; for default (none)" />
 36        <param name="rgds" value="" type="text" label="Read group description" help="Leave set to &lt;null&gt; for default (none)" />
 37      </when>
 38    </conditional>
 39    <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output bam instead of sam" help="Uncheck for sam output" />
 40  </inputs>
 41  <outputs>
 42    <data name="outFile" format="bam" label="${tool.name} on ${on_string}: ${outputFormat} with read groups replaced">
 43      <change_format>
 44        <when input="outputFormat" value="sam" format="sam" />
 45      </change_format>
 46    </data>
 47  </outputs>
 48  <tests>
 49    <test>
 50      <!-- Command for replacing read groups in bam:
 51      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
 52      -->
 53      <param name="inputFile" value="picard_ARRG_input1.bam" />
 54      <param name="rglb" value="lib" />
 55      <param name="rgpl" value="illumina" />
 56      <param name="rgpu" value="peaewe" />
 57      <param name="rgsm" value="sam1" />
 58      <param name="rgid" value="one" />
 59      <param name="rgOpts" value="preSet" />
 60      <param name="outputFormat" value="False" />
 61      <output name="outFile" file="picard_ARRG_output1.sam" ftype="sam" />
 62    </test>
 63    <test>
 64      <!-- Command for replacing read groups in sam:
 65      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"
 66      picard_ARRG_input1.bam can be created from picard_ARRG_input1.sam
 67      -->
 68      <param name="inputFile" value="picard_ARRG_input1.sam" />
 69      <param name="rglb" value="LIB" />
 70      <param name="rgpl" value="IL" />
 71      <param name="rgpu" value="PLAT" />
 72      <param name="rgsm" value="smp" />
 73      <param name="rgid" value="M5" />
 74      <param name="rgOpts" value="full" />
 75      <param name="rgcn" value="FamousCenter" />
 76      <param name="rgds" value="description with spaces" />
 77      <param name="outputFormat" value="False" />
 78      <output name="outFile" file="picard_ARRG_output2.sam" ftype="sam" />
 79    </test>
 80    <test>
 81      <!-- Command for adding read groups in sam:
 82      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
 83      -->
 84      <param name="inputFile" value="picard_ARRG_input2.sam" />
 85      <param name="rglb" value="LIB" />
 86      <param name="rgpl" value="IL" />
 87      <param name="rgpu" value="PLAT" />
 88      <param name="rgsm" value="smp1" />
 89      <param name="rgid" value="M6" />
 90      <param name="rgOpts" value="preSet" />
 91      <param name="outputFormat" value="True" />
 92      <output name="outFile" file="picard_ARRG_output3.bam" ftype="bam" />
 93    </test>
 94  </tests>
 95  <help>
 96
 97.. class:: infomark
 98
 99**Purpose**
100
101Add or Replace Read Groups in an input BAM or SAM file.
102
103**Read Groups are Important!**
104
105Many 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:
106
107.. csv-table::
108   :header-rows: 1
109    
110    Tag,Importance,Definition,Meaning
111    "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."
112    "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)."
113    "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."
114    "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."
115
116**Example of Read Group usage**
117
118Support 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::
119
120 Dad's data:
121 @RG     ID:FLOWCELL1.LANE1      PL:illumina     LB:LIB-DAD-1 SM:DAD      PI:200
122 @RG     ID:FLOWCELL1.LANE2      PL:illumina     LB:LIB-DAD-1 SM:DAD      PI:200
123 @RG     ID:FLOWCELL1.LANE3      PL:illumina     LB:LIB-DAD-2 SM:DAD      PI:400
124 @RG     ID:FLOWCELL1.LANE4      PL:illumina     LB:LIB-DAD-2 SM:DAD      PI:400
125  
126 Mom's data:
127 @RG     ID:FLOWCELL1.LANE5      PL:illumina     LB:LIB-MOM-1 SM:MOM      PI:200
128 @RG     ID:FLOWCELL1.LANE6      PL:illumina     LB:LIB-MOM-1 SM:MOM      PI:200
129 @RG     ID:FLOWCELL1.LANE7      PL:illumina     LB:LIB-MOM-2 SM:MOM      PI:400
130 @RG     ID:FLOWCELL1.LANE8      PL:illumina     LB:LIB-MOM-2 SM:MOM      PI:400
131 
132 Kid's data:
133 @RG     ID:FLOWCELL2.LANE1      PL:illumina     LB:LIB-KID-1 SM:KID      PI:200
134 @RG     ID:FLOWCELL2.LANE2      PL:illumina     LB:LIB-KID-1 SM:KID      PI:200
135 @RG     ID:FLOWCELL2.LANE3      PL:illumina     LB:LIB-KID-2 SM:KID      PI:400
136 @RG     ID:FLOWCELL2.LANE4      PL:illumina     LB:LIB-KID-2 SM:KID      PI:400
137
138Note 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).
139
140**Picard documentation**
141
142This is a Galaxy wrapper for AddOrReplaceReadGroups, a part of the external package Picard-tools_.
143
144 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
145
146------
147
148.. class:: infomark
149
150**Inputs, outputs, and parameters**
151
152Either a sam file or a bam file must be supplied. If a bam file is used, it must
153be coordinate-sorted. Galaxy currently coordinate-sorts all bam files.
154
155The output file is either bam (the default) or sam, according to user selection,
156and contains the same information as the input file except for the appropraite
157additional (or modified) read group tags. Bam is recommended since it is smaller.
158
159From the Picard documentation.
160
161AddOrReplaceReadGroups REQUIRED parameters::
162
163  Option (Type)    Description
164  
165  RGLB=String      Read Group Library
166  RGPL=String      Read Group platform (e.g. illumina, solid)
167  RGPU=String      Read Group platform unit (eg. run barcode)
168  RGSM=String      Read Group sample name
169  RGID=String      Read Group ID; Default value: null (empty)
170
171AddOrReplaceReadGroups OPTIONAL parameters::
172
173  Option (Type)    Description
174  
175  RGCN=String      Read Group sequencing center name; Default value: null (empty)
176  RGDS=String      Read Group description Default value: null (empty)
177
178One parameter that Picard's AddOrReplaceReadGroups offers that is automatically
179set by Galaxy is the SORT_ORDER, which is set to coordinate.
180
181.. class:: warningmark
182
183**Warning on SAM/BAM quality**
184
185Many 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**
186flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
187to be the only way to deal with SAM/BAM that cannot be parsed.
188
189
190
191  </help>
192</tool>
193
194
195
196
197
198
199
200
201
202
203
204