annotate bwa_macros.xml @ 0:ff1ae217ccc2 draft

Uploaded
author devteam
date Tue, 16 Dec 2014 15:22:56 -0500
parents
children e29bc5c169bc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
1 <macros>
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
2
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
3 <token name="@RG@">
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
4 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
5
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
6 .. class:: warningmark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
7
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
8 **Read Groups are Important!**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
9
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
10 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
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
11 **Specify readgroup information?** widget. If you are not familiar with readgroups you shold know that this is effectively a way to tag reads with an additional ID.
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
12 This allows you to combine BAM files from, for example, multiple BWA runs into a single dataset. This significantly simplifies downstream processing as
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
13 instead of dealing with multiple datasets you only have to handle only one. This is possible because the readgroup information allows you to identify
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
14 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
15 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
16
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
17 **Description of read groups fields**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
18
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
19 (from GATK FAQ webpage):
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
20
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
21 .. csv-table::
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
22 :header-rows: 1
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
23
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
24 Tag,Importance,Definition,Meaning
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
25 "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
26 "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
27 "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
28 "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
29
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
30
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
31 **Example of Read Group usage**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
32
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
33 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
34
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
35 Dad's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
36 @RG ID:FLOWCELL1.LANE1 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
37 @RG ID:FLOWCELL1.LANE2 PL:illumina LB:LIB-DAD-1 SM:DAD PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
38 @RG ID:FLOWCELL1.LANE3 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
39 @RG ID:FLOWCELL1.LANE4 PL:illumina LB:LIB-DAD-2 SM:DAD PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
40
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
41 Mom's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
42 @RG ID:FLOWCELL1.LANE5 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
43 @RG ID:FLOWCELL1.LANE6 PL:illumina LB:LIB-MOM-1 SM:MOM PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
44 @RG ID:FLOWCELL1.LANE7 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
45 @RG ID:FLOWCELL1.LANE8 PL:illumina LB:LIB-MOM-2 SM:MOM PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
46
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
47 Kid's data:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
48 @RG ID:FLOWCELL2.LANE1 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
49 @RG ID:FLOWCELL2.LANE2 PL:illumina LB:LIB-KID-1 SM:KID PI:200
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
50 @RG ID:FLOWCELL2.LANE3 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
51 @RG ID:FLOWCELL2.LANE4 PL:illumina LB:LIB-KID-2 SM:KID PI:400
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
52
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
53 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).
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
54 </token>
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
55 <token name="@info@">
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
56 -----
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
57
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
58 .. class:: infomark
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
59
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
60 **More info**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
61
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
62 To obtain more information about BWA and ask questions use these resources:
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
63
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
64 1. https://biostar.usegalaxy.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
65 2. https://www.biostars.org/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
66 3. https://github.com/lh3/bwa
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
67 4. http://bio-bwa.sourceforge.net/
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
68
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
69 </token>
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
70
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
71 <token name="@dataset_collections@">
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
72 ------
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
73
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
74 **Dataset collections - processing large numbers of datasets at once**
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
75
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
76 This will be added shortly
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
77
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
78
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
79 </token>
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
80
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
81
ff1ae217ccc2 Uploaded
devteam
parents:
diff changeset
82 </macros>