annotate bwa_macros.xml @ 2:e29bc5c169bc draft

Uploaded
author devteam
date Fri, 20 Mar 2015 12:09:08 -0400
parents ff1ae217ccc2
children ac30bfd3e2a8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
1 <macros>
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
3 <token name="@set_rg_string@">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
4 #set $rg_string = "@RG\tID:" + str($rg.ID) + "\tSM:" + str($rg.SM) + "\tPL:" + str($rg.PL)
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
5 #if $rg.LB
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
6 #set $rg_string += "\tLB:$rg.LB"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
7 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
8 #if $rg.CN
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
9 #set $rg_string += "\tCN:$rg.CN"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
10 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
11 #if $rg.DS
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
12 #set $rg_string += "\tDS:$rg.DS"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
13 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
14 #if $rg.DT
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
15 #set $rg_string += "\tDT:$rg.DT"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
16 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
17 #if $rg.FO
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
18 #set $rg_string += "\tFO:$rg.FO"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
19 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
20 #if $rg.KS
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
21 #set $rg_string += "\tKS:$rg.KS"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
22 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
23 #if $rg.PG
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
24 #set $rg_string += "\tPG:$rg.PG"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
25 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
26 #if str($rg.PI)
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
27 #set $rg_string += "\tPI:$rg.PI"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
28 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
29 #if $rg.PU
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
30 #set $rg_string += "\tPU:$rg.PU"
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
31 #end if
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
32 </token>
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
33
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
34 <token name="@RG@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
35 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
36
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
37 .. class:: warningmark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
38
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
39 **Read Groups are Important!**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
40
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
41 One of the recommended best practices in NGS analysis is adding read group information to BAM files. You can do thid directly in BWA interface using the
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
42 **Specify read group information?** widget. If you are not familiar with read groups you shold know that this is effectively a way to tag reads with an additional ID.
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
43 This allows you to combine BAM files from, for example, multiple BWA runs into a single dataset. This significantly simplifies downstream processing as
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
44 instead of dealing with multiple datasets you only have to handle only one. This is possible because the read group information allows you to identify
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
45 data from different experiments even if they are combined in one file. Many downstream analysis tools such as varinat callers (e.g., FreeBayes or Naive Varinat Caller
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
46 present in Galaxy) are aware of readgtroups and will automatically generate calls for each individual sample even if they are combined within a single file.
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
47
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
48 **Description of read groups fields**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
49
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
50 (from GATK FAQ webpage):
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
51
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
52 .. csv-table::
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
53 :header-rows: 1
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
54
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
55 Tag,Importance,Definition,Meaning
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
56 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
57 "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)."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
58 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
59 "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."
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
60
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
61
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
62 **Example of Read Group usage**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
63
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
64 Suppose 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::
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
65
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
66 Dad's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
67 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
68 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
69 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
70 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
71
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
72 Mom's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
73 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
74 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
75 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
76 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
77
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
78 Kid's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
79 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
80 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
81 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
82 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
83
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
84 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).
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
85 </token>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
86 <token name="@info@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
87 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
88
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
89 .. class:: infomark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
90
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
91 **More info**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
92
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
93 To obtain more information about BWA and ask questions use these resources:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
94
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
95 1. https://biostar.usegalaxy.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
96 2. https://www.biostars.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
97 3. https://github.com/lh3/bwa
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
98 4. http://bio-bwa.sourceforge.net/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
99
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
100 </token>
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
101
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
102 <token name="@dataset_collections@">
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
103 ------
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
104
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
105 **Dataset collections - processing large numbers of datasets at once**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
106
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
107 This will be added shortly
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
108
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
109
2
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
110 </token>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
111 <xml name="readgroup_params">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
112 <conditional name="rg">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
113 <param name="rg_selector" type="select" label="Set read groups information?" help="-R; Specifying read group information can greatly simplify your downstream analyses by allowing combining multiple datasets. See help below for more details">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
114 <option value="set">Set</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
115 <option value="do_not_set" selected="True">Do not set</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
116 </param>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
117 <when value="set">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
118 <param name="ID" type="text" value="" size="20" label="Read group identifier (ID)" help="This value must be unique among multiple samples in your experiment">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
119 <validator type="empty_field" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
120 </param>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
121 <param name="SM" type="text" value="" size="20" label="Read group sample name (SM)" help="This value should be descriptive. Use pool name where a pool is being sequenced" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
122 <param name="PL" type="select" label="Platform/technology used to produce the reads (PL)">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
123 <option value="CAPILLARY">CAPILLARY</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
124 <option value="LS454">LS454</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
125 <option value="ILLUMINA">ILLUMINA</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
126 <option value="SOLID">SOLID</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
127 <option value="HELICOS">HELICOS</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
128 <option value="IONTORRENT">IONTORRENT</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
129 <option value="PACBIO">PACBIO</option>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
130 </param>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
131 <param name="LB" type="text" size="25" label="Library name (LB)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
132 <param name="CN" type="text" size="25" label="Sequencing center that produced the read (CN)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
133 <param name="DS" type="text" size="25" label="Description (DS)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
134 <param name="DT" type="text" size="25" label="Date that run was produced (DT)" help="ISO8601 format date or date/time, like YYYY-MM-DD" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
135 <param name="FO" type="text" size="25" optional="true" label="Flow order (FO)" help="The array of nucleotide bases that correspond to the nucleotides used for each flow of each read. Multi-base flows are encoded in IUPAC format, and non-nucleotide flows by various other characters. Format: /\*|[ACMGRSVTWYHKDBN]+/">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
136 <validator type="regex" message="Invalid flow order">\*|[ACMGRSVTWYHKDBN]+$</validator>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
137 </param>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
138 <param name="KS" type="text" size="25" label="The array of nucleotide bases that correspond to the key sequence of each read (KS)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
139 <param name="PG" type="text" size="25" label="Programs used for processing the read group (PG)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
140 <param name="PI" type="integer" optional="true" label="Predicted median insert size (PI)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
141 <param name="PU" type="text" size="25" label="Platform unit (PU)" help="Unique identifier (e.g. flowcell-barcode.lane for Illumina or slide for SOLiD)" />
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
142 </when>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
143 <when value="do_not_set">
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
144 <!-- do nothing -->
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
145 </when>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
146 </conditional>
e29bc5c169bc Uploaded
devteam
parents: 0
diff changeset
147 </xml>
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
148
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
149 </macros>