Tip | ||
---|---|---|
| ||
Use our summer school reservation ( CoreNGS) when submitting batch jobs to get higher priority on the ls6 normal queue
|
Table of Contents |
---|
Overview
After raw sequence files are generated (in FASTQ format), quality-checked, and pre-processed in some way, the next step in many NGS pipelines is mapping to a reference genome.
For individual sequences it is common to use a tool like BLAST to identify genes or species of origin. However a normal NGS dataset will have tens to hundreds of millions of sequences, which BLAST and similar tools are not designed to handle. Thus a large set of computational tools have been developed to quickly align each read to its best location (if any) in a reference.
Even though many mapping tools exist, a few individual programs have a dominant "market share" of the NGS world. In this section, we will primarily focus on two of the most versatile general-purpose ones: BWA and Bowtie2 (the latter being part of the Tuxedo suite which includes the transcriptome-aware RNA-seq aligner Tophat2 as well as other downstream quantifiaction tools).
Stage the alignment data
First connect to ls6.tacc.utexas.edu and start an idev session. This should be second nature by now
Code Block | ||||
---|---|---|---|---|
| ||||
idev -p normal -m 180 -A OTH21164 -N 1 |
Then stage the sample datasets and references we will use.
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/references/fasta
cp $CORENGS/references/*.fa $SCRATCH/core_ngs/references/fasta/
mkdir -p $SCRATCH/core_ngs/alignment/fastq
cp $CORENGS/alignment/*fastq.gz $SCRATCH/core_ngs/alignment/fastq/
cd $SCRATCH/core_ngs/alignment/fastq |
These are descriptions of the FASTQ files we copied:
...
Reference Genomes
Before we get to alignment, we need a reference to align to. This is usually an organism's genome, but can also be any set of names sequences, such as a transcriptome or other set of genes.
Here are the four reference genomes we will be using today, with some information about them. These are not necessarily the most recent versions of these references (e.g. the newest human reference genome is hg38 and the most recent miRBase annotation is v21. (See here for information about many more genomes.)
...
Searching genomes is computationally hard work and takes a long time if done on linear genomic sequence. So aligners require that references first be indexed to accelerate lookup. The aligners we are using each require a different index, but use the same method (the Burrows-Wheeler Transform) to get the job done.
Building a reference index involves taking a FASTA file as input, with each contig (contiguous string of bases, e.g. a chromosome) as a separate FASTA entry, and producing an aligner-specific set of files as output. Those output index files are then used to perform the sequence alignment, and alignments are reported using coordinates referencing names and offset positions based on the original FASTA file contig entries.
We can quickly index the references for the yeast genome, the human miRNAs, and the V. cholerae genome, because they are all small, so we'll build each index from the appropriate FASTA files right before we use them.
hg19 is way too big for us to index here so we will use an existing set of BWA hg19 index files located at:
Code Block | ||||
---|---|---|---|---|
| ||||
/work/projects/BioITeam/ref_genome/bwa/bwtsw/hg19 |
...
The BioITeam maintains a set of reference indexes for many common organisms and aligners. They can be found in aligner-specific sub-directories of the /work/projects/BioITeam/ref_genome area. E.g.:
Code Block | ||
---|---|---|
| ||
/work/projects/BioITeam/ref_genome/
bowtie2/
bwa/
hisat2/
kallisto/
star/
tophat/ |
Exploring FASTA with grep
It is often useful to know what chromosomes/contigs are in a FASTA file before you start an alignment so that you're familiar with the contig naming convention – and to verify that it's the one you expect. For example, chromosome 1 is specified differently in different references and organisms: chr1 (USCS human), chrI (UCSC yeast), or just 1 (Ensembl human GRCh37).
A FASTA file consists of a number of contig name entries, each one starting with a right carat ( > ) character, followed by many lines of base characters. E.g.:
Code Block |
---|
>chrI
CCACACCACACCCACACACCCACACACCACACCACACACCACACCACACC
CACACACACACATCCTAACACTACCCTAACACAGCCCTAATCTAACCCTG
GCCAACCTGTCTCTCAACTTACCCTCCATTACCCTGCCTCCACTCGTTAC
CCTGTCCCATTCAACCATACCACTCCGAACCACCATCCATCCCTCTACTT |
How do we dig out just the lines that have the contig names and ignore all the sequences? Well, the contig name lines all follow the pattern above, and since the > character is not a valid base, it will never appear on a sequence line.
We've discovered a pattern (also known as a regular expression) to use in searching, and the command line tool that does regular expression matching is grep (general regular expression parser). Read more about grep here: Advanced commands: grep.
Regular expressions are so powerful that nearly every modern computer language includes a "regex" module of some sort. There are many online tutorials for regular expressions, and several slightly different "flavors" of them. But the most common is the Perl style (http://perldoc.perl.org/perlretut.html), which was one of the fist and still the most powerful (there's a reason Perl was used extensively when assembling the human genome). We're only going to use simple regular expressions here, but learning more about them will pay handsome dividends for you in the future.
Here's how to execute grep to list contig names in a FASTA file.
Code Block | ||||
---|---|---|---|---|
| ||||
# If you haven't staged the fasta files
cds
mkdir -p core_ngs/references/fasta
cd core_ngs/references/fasta
cp $CORENGS/references/*.fa .
cd $SCRATCH/core_ngs/references/fasta
grep -P '^>' sacCer3.fa | more |
Notes:
- The -P option tells grep to Perl-style regular expression patterns.
- This makes including special characters like Tab ( \t ), Carriage Return ( \r ) or Linefeed ( \n ) much easier that the default POSIX paterns.
- While it is not required here, it generally doesn't hurt to include this option.
'^>' is the regular expression describing the pattern we're looking for (described below)
- sacCer3.fa is the file to search.
- lines with text that match our pattern will be written to standard output
- non matching lines will be omitted
- We pipe to more just in case there are a lot of contig names.
Now down to the nuts and bolts of the pattern: '^>'
First, the single quotes around the pattern – this tells the bash shell to pass the exact string contents to grep.
As part of its friendly command line parsing and evaluation, the shell will often look for special characters on the command line that mean something to it (for example, the $ in front of an environment variable name, like in $SCRATCH). Well, regular expressions treat the $ specially too – but in a completely different way! Those single quotes tell the shell "don't look inside here for special characters – treat this as a literal string and pass it to the program". The shell will obey, will strip the single quotes off the string, and will pass the actual pattern, ^>, to the grep program. (Note that the shell does look inside double quotes ( " ) for certain special signals, such as looking for environment variable names to evaluate. Read more about Quoting in the shell.)
So what does ^> mean to grep? We know that contig name lines always start with a > character, so > is a literal for grep to use in its pattern match.
We might be able to get away with just using this literal alone as our regex, specifying '>' as the command line argument. But for grep, the more specific the pattern, the better. So we constrain where the > can appear on the line. The special carat ( ^ ) metacharacter represents "beginning of line". So ^> means "beginning of a line followed by a > character".
Exercise: How many contigs are there in the sacCer3 reference?
Expand | ||||
---|---|---|---|---|
| ||||
Code Block | | |||
|
Code Block | ||||
---|---|---|---|---|
| ||||
# Request a 180 minute interactive node on the normal queue using our reservation
idev -m 120 -N 1 -A OTH21164 -r CoreNGS
idev -m 120 -N 1 -A TRA23004 -r CoreNGS
# Request a 120 minute idev node on the development queue
idev -m 120 -N 1 -A OTH21164 -p development
idev -m 120 -N 1 -A TRA23004 -p development |
Code Block | ||||
---|---|---|---|---|
| ||||
# Using our reservation
sbatch --reseservation=CoreNGS <batch_file>.slurm |
Note that the reservation name (CoreNGS) is different from the TACC allocation/project for this class, which is OTH21164.
Table of Contents |
---|
Overview
After raw sequence files are generated (in FASTQ format), quality-checked, and pre-processed in some way, the next step in many NGS pipelines is mapping to a reference genome.
For individual sequences it is common to use a tool like BLAST to identify genes or species of origin. However a normal NGS dataset will have tens to hundreds of millions of sequences, which BLAST and similar tools are not designed to handle. Thus a large set of computational tools have been developed to quickly align each read to its best location (if any) in a reference.
Even though many mapping tools exist, a few individual programs have a dominant "market share" of the NGS world. In this section, we will primarily focus on two of the most versatile general-purpose ones: BWA and Bowtie2 (the latter being part of the Tuxedo suite which includes the transcriptome-aware RNA-seq aligner Tophat2 as well as other downstream quantification tools).
Stage the alignment data
First connect to ls6.tacc.utexas.edu and start an idev session. This should be second nature by now
Code Block | ||||
---|---|---|---|---|
| ||||
idev -m 180 -N 1 -A OTH21164 -r CoreNGS |
Then stage the sample datasets and references we will use.
Code Block | ||||
---|---|---|---|---|
| ||||
# Copy the FASTA files for building references
mkdir -p $SCRATCH/core_ngs/references/fasta
cp $CORENGS/references/fasta/*.fa $SCRATCH/core_ngs/references/fasta/
# Copy the FASTQ files that will be used for alignment
mkdir -p $SCRATCH/core_ngs/alignment/fastq
cp $CORENGS/alignment/*fastq.gz $SCRATCH/core_ngs/alignment/fastq/
cd $SCRATCH/core_ngs/alignment/fastq |
These are descriptions of the FASTQ files we copied:
File Name | Description | Sample |
---|---|---|
Sample_Yeast_L005_R1.cat.fastq.gz | Paired-end Illumina, First of pair, FASTQ | Yeast ChIP-seq |
Sample_Yeast_L005_R2.cat.fastq.gz | Paired-end Illumina, Second of pair, FASTQ | Yeast ChIP-seq |
human_rnaseq.fastq.gz | Paired-end Illumina, First of pair only, FASTQ | Human RNA-seq |
human_mirnaseq.fastq.gz | Single-end Illumina, FASTQ | Human microRNA-seq |
cholera_rnaseq.fastq.gz | Single-end Illumina, FASTQ | V. cholerae RNA-seq |
Reference Genomes
Before we get to alignment, we need a reference to align to. This is usually an organism's genome, but can also be any set of names sequences, such as a transcriptome or other set of genes.
Here are the four reference genomes we will be using today, with some information about them. These are not necessarily the most recent versions of these references (e.g. the newest human reference genome is hg38 and a recent miRBase version is v21. (See here for information about many more genomes.)
Reference | Species | Base Length | Contig Number | Source | Download |
---|---|---|---|---|---|
hg19 | Human | 3.1 Gbp | 25 (really 93) | UCSC | UCSC GoldenPath |
sacCer3 | Yeast | 12.2 Mbp | 17 | UCSC | UCSC GoldenPath |
mirbase v20 | Human subset | 160 Kbp | 1908 | miRBase | miRBase Downloads |
vibCho (O395) | Vibrio cholerae | ~4 Mbp | 2 | GenBank | GenBank Downloads |
Searching genomes is computationally hard work and takes a long time if done on linear genomic sequence. So aligners require that references first be indexed to accelerate lookup. The aligners we are using each require a different index, but use the same method (the Burrows-Wheeler Transform) to get the job done.
Building a reference index involves taking a FASTA file as input, with each contig (contiguous string of bases, e.g. a chromosome) as a separate FASTA entry, and producing an aligner-specific set of files as output. Those output index files are then used to perform the sequence alignment, and alignments are reported using coordinates referencing names and offset positions based on the original FASTA file contig entries.
We can quickly index the references for the yeast genome, the human miRNAs, and the V. cholerae genome, because they are all small, so we'll build each index from the appropriate FASTA files right before we use them.
hg19 is way too big for us to index here so we will use an existing set of BWA hg19 index files located at:
Code Block | ||||
---|---|---|---|---|
| ||||
/work/projects/BioITeam/ref_genome/bwa/bwtsw/hg19 |
Tip | |||||
---|---|---|---|---|---|
The BioITeam maintains a set of reference indexes for many common organisms and aligners. They can be found in aligner-specific sub-directories of the /work/projects/BioITeam/ref_genome area. E.g.:
|
Exploring FASTA with grep
It is often useful to know what chromosomes/contigs are in a FASTA file before you start an alignment so that you're familiar with the contig naming convention – and to verify that it's the one you expect. For example, chromosome 1 is specified differently in different references and organisms: chr1 (USCS human), chrI (UCSC yeast), or just 1 (Ensembl human GRCh37).
A FASTA file consists of a number of contig name entries, each one starting with a right carat ( > ) character, followed by many lines of base characters. E.g.:
Code Block |
---|
>chrI
CCACACCACACCCACACACCCACACACCACACCACACACCACACCACACC
CACACACACACATCCTAACACTACCCTAACACAGCCCTAATCTAACCCTG
GCCAACCTGTCTCTCAACTTACCCTCCATTACCCTGCCTCCACTCGTTAC
CCTGTCCCATTCAACCATACCACTCCGAACCACCATCCATCCCTCTACTT |
How do we dig out just the lines that have the contig names and ignore all the sequences? Well, the contig name lines all follow the pattern above, and since the > character is not a valid base, it will never appear on a sequence line.
We've discovered a pattern (also known as a regular expression) to use in searching, and the command line tool that does regular expression matching is grep (general regular expression parser). (Read more about grep and regular expressions)
Regular expressions are so powerful that nearly every modern computer language includes a "regex" module of some sort. There are many online tutorials for regular expressions, and several slightly different "flavors" of them. But the most common is the Perl style (http://perldoc.perl.org/perlretut.html), which was one of the fist and still the most powerful (there's a reason Perl was used extensively when assembling the human genome). We're only going to use simple regular expressions here, but learning more about them will pay handsome dividends for you in the future.
Here's how to execute grep to list contig names in a FASTA file.
Code Block | ||||
---|---|---|---|---|
| ||||
# Stage the FASTA files cds mkdir -p core_ngs/references/fasta cd core_ngs/references/fasta cp $CORENGS/references/fasta/*.fa$SCRATCH/core_ngs/references/fasta/ | ||||
Expand | ||||
|
Exercise #1: BWA global alignment – Yeast ChIP-seq
Overview ChIP-seq alignment workflow with BWA
We will perform a global alignment of the paired-end Yeast ChIP-seq sequences using bwa. This workflow has the following steps:
- Trim the FASTQ sequences down to 50 with fastx_clipper
- this removes most of any 5' adapter contamination without the fuss of specific adapter trimming w/cutadapt
- Prepare the sacCer3 reference index for bwa using bwa index
- this is done once, and re-used for later alignments
- Perform a global bwa alignment on the R1 reads (bwa aln) producing a BWA-specific binary .sai intermediate file
- Perform a global bwa alignment on the R2 reads (bwa aln) producing a BWA-specific binary .sai intermediate file
- Perform pairing of the separately aligned reads and report the alignments in SAM format using bwa sampe
- Convert the SAM file to a BAM file (samtools view)
- Sort the BAM file by genomic location (samtools sort)
- Index the BAM file (samtools index)
- Gather simple alignment statistics (samtools flagstat and samtools idxstat)
We're going to skip the trimming step for now and see how it goes. We'll perform steps 2 - 5 now and leave samtools for a later exercise since steps 6 - 10 are common to nearly all post-alignment workflows.
Introducing BWA
Like other tools you've worked with so far, you first need to load bwa. Do that now, and then enter bwa with no arguments to view the top-level help page (many NGS tools will provide some help when called with no arguments). bwa is available as a BioContainers. module.
Expand | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
idev -m 120 -A OTH21164 -N 1 -r CoreNGSday4 |
language | bash |
---|
language | bash |
---|
. cd $SCRATCH/core_ngs/references/fasta grep -P '^>' sacCer3.fa |wc -l
Or use grep's -c option that says "just count the line matches"
Code Block | ||
---|---|---|
| ||
grep -P -c '^>' sacCer3.fa |
Expand | ||
---|---|---|
| ||
There are 17 contigs. |
Aligner overview
There are many aligners available, but we will concentrate on two of the most popular general-purpose ones: bwa and bowtie2. The table below outlines the available protocols for them.
...
single end reads:
- bwa aln <R1>
- bwa samse
paired end reads:
- bwa aln <R1>
- bwa aln <R2>
- bwa sampe
...
- simple to use (take default options)
- good for basic global alignment
...
- multiple steps needed
...
- extremely configurable
- can be used for RNAseq alignment (after adapter trimming) because of its many options
...
- complex (many options)
...
- simple to use (take default options)
- very fast
- no adapter trimming needed
- good for simple RNAseq analysis
- the secondary alignments it reports provide splice junction information
...
- always produces alignments with secondary reads
- must be filtered if not desired
...
- extremely configurable
- no adapter trimming needed
- good for small RNA alignment because of its many options
...
- complex – many options
module load biocontainers # takes a more |
Notes:
- The -P option tells grep to Perl-style regular expression patterns.
- This makes including special characters like Tab ( \t ), carriage return ( \r ) or linefeed ( \n ) much easier that the default POSIX paterns.
- While it is not required here, it generally doesn't hurt to include this option.
'^>' is the regular expression describing the pattern we're looking for (described below)
- sacCer3.fa is the file to search.
- lines with text that match our pattern will be written to standard output
- non matching lines will be omitted
- We pipe to more just in case there are a lot of contig names.
Now down to the nuts and bolts of the pattern: '^>'
First, the single quotes around the pattern – this tells the bash shell to pass the exact string contents to grep.
As we have seen, during command line parsing and evaluation the shell will often look for special metacharacters on the command line that mean something to it (for example, the $ in front of an environment variable name, like in $SCRATCH). Well, regular expressions treat the $ specially too – but in a completely different way! Those single quotes tell the shell "don't look inside here for special characters – treat this as a literal string and pass it to the program". The shell will obey, will strip the single quotes off the string, and will pass the actual pattern, ^>, to the grep program. (Read more about Literal characters and metacharacters and Quoting in the shell)
So what does ^> mean to grep? We know that contig name lines always start with a > character, so > is a literal for grep to use in its pattern match.
We might be able to get away with just using this literal alone as our regex, specifying '>' as the command line pattern argument. But for grep, the more specific the pattern, the better. So we constrain where the > can appear on the line. The special carat ( ^ ) metacharacter represents "beginning of line". So ^> means "beginning of a line followed by a > character".
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Exercise: How many contigs are there in the sacCer3 reference?
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Or use grep's -c option that says "just count the line matches"
|
Expand | ||
---|---|---|
| ||
There are 17 contigs. |
Aligner overview
There are many aligners available, but we will concentrate on two of the most popular general-purpose ones: bwa and bowtie2. The table below outlines the available protocols for them.
alignment type | aligner options | pro's | con's |
---|---|---|---|
global with bwa | single end reads:
paired end reads:
|
|
|
global with bowtie2 | bowtie2 |
|
|
local with bwa | bwa mem |
|
|
local with bowtie2 | bowtie2 --local |
|
|
Exercise #1: BWA global alignment – Yeast ChIP-seq
Overview ChIP-seq alignment workflow with BWA
We will perform a global alignment of the paired-end Yeast ChIP-seq sequences using bwa. This workflow has the following steps:
- Trim the FASTQ sequences down to 50 with fastx_clipper
- this removes most of any 5' adapter contamination without the fuss of specific adapter trimming w/cutadapt
- Prepare the sacCer3 reference index for bwa using bwa index
- this is done once, and re-used for later alignments
- Perform a global bwa alignment on the R1 reads (bwa aln) producing a BWA-specific binary .sai intermediate file
- Perform a global bwa alignment on the R2 reads (bwa aln) producing a BWA-specific binary .sai intermediate file
- Perform pairing of the separately aligned reads and report the alignments in SAM format using bwa sampe
- Convert the SAM file to a BAM file (samtools view)
- Sort the BAM file by genomic location (samtools sort)
- Index the BAM file (samtools index)
- Gather simple alignment statistics (samtools flagstat and samtools idxstats)
We're going to skip the trimming step and perform steps 2 - 5 now, leaving samtools for a later exercise since steps 6 - 10 are common to nearly all post-alignment workflows.
Introducing BWA
Like other tools you've worked with so far, you first need to load bwa. Do that now, and then enter bwa with no arguments to view the top-level help page (many NGS tools will provide some help when called with no arguments). bwa is available as a BioContainers. module.
Make sure you're in an idev session
Code Block | ||||
---|---|---|---|---|
| ||||
idev -m 180 -N 1 -A OTH21164 -r CoreNGS # or -A TRA23004
idev -m 120 -N 1 -A OTH21164 -p development # or -A TRA23004 |
Code Block | ||
---|---|---|
| ||
module load biocontainers # takes a while
module load bwa
bwa |
...
Code Block | ||
---|---|---|
| ||
Program: bwa (alignment via Burrows-Wheeler transformation) Version: 0.7.17-r1188 Contact: Heng Li <lh3@sanger.ac.uk> Usage: bwa <command> [options] Command: index index sequences in the FASTA format mem BWA-MEM algorithm fastmap identify super-maximal exact matches pemerge merge overlapping paired ends (EXPERIMENTAL) aln gapped/ungapped alignment samse generate alignment (single ended) sampe generate alignment (paired ended) bwasw BWA-SW for long queries shm manage indices in shared memory fa2pac convert FASTA to PAC format pac2bwt generate BWT from PAC pac2bwtgen alternative algorithm for generating BWT bwtupdate update .bwt to the update .bwt to the new format bwt2sa generate SA from BWT and Occ Note: To use BWA, you need to first index the genome with `bwa index'. There are three alignment algorithms in BWA: `mem', `bwasw', and `aln/samse/sampe'. If you are not sure which to use, try `bwa mem' first. Please `man ./bwa.1' for the manual. |
As you can see, bwa include many sub-commands that perform the tasks we are interested in.
Building the BWA sacCer3 index
We will index the genome with the bwa index command. Type bwa index with no arguments to see usage for this sub-command.
Code Block | ||
---|---|---|
| ||
Usage: bwa index [options] <in.fasta>
Options: -a STR BWT construction algorithm: bwtsw, is or rb2 [auto]
-p STR prefix of the index [same as fasta name]
-b INT block size for the bwtsw algorithm (effective with -a bwtsw) [10000000]
-6 index files named as <in.fasta>.64.* instead of <in.fasta>.*
Warning: `-a bwtsw' does not work for short genomes, while `-a is' and
`-a div' do not work not for long genomes. |
Based on the usage description, we only need to specify two things:
- The name of the FASTA file
- Whether to use the bwtsw or is algorithm for indexing
Since sacCer3 is relative large (~12 Mbp) we will specify bwtsw as the indexing option (as indicated by the "Warning" message), and the name of the FASTA file is sacCer3.fa.
The output of this command is a group of files that are all required together as the index. So, within our references directory, we will create another directory called references/bwa/sacCer3 and build the index there. To remind ourselves which FASTA was used to build the index, we create a symbolic link to our references/fasta/sacCer3.fa file (note the use of the ../.. relative path syntax).
...
title | Setup (if needed) |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/alignment/fastq
mkdir -p $SCRATCH/core_ngs/references/fasta
cp $CORENGS/alignment/*fastq.gz $SCRATCH/core_ngs/alignment/fastq/
cp $CORENGS/references/*.fa $SCRATCH/core_ngs/references/fasta/ |
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/references/bwa/sacCer3
cd $SCRATCH/core_ngs/references/bwa/sacCer3
ln -s ../../fasta/sacCer3.fa
ls -l |
...
new format
bwt2sa generate SA from BWT and Occ
Note: To use BWA, you need to first index the genome with `bwa index'.
There are three alignment algorithms in BWA: `mem', `bwasw', and
`aln/samse/sampe'. If you are not sure which to use, try `bwa mem'
first. Please `man ./bwa.1' for the manual. |
As you can see, bwa include many sub-commands that perform the tasks we are interested in.
Building the BWA sacCer3 index
We will index the genome with the bwa index command. Type bwa index with no arguments to see usage for this sub-command.
Code Block | ||
---|---|---|
| ||
Usage: bwa index [options] <in.fasta>
Options: -a STR BWT construction algorithm: bwtsw, is or rb2 [auto]
-p STR prefix of the index [same as fasta name]
-b INT block size for the bwtsw algorithm (effective with -a bwtsw) [10000000]
-6 index files named as <in.fasta>.64.* instead of <in.fasta>.*
Warning: `-a bwtsw' does not work for short genomes, while `-a is' and
`-a div' do not work not for long genomes. |
Based on the usage description, we only need to specify two things:
- The name of the FASTA file
- Whether to use the bwtsw or is algorithm for indexing
Since sacCer3 is relative large (~12 Mbp) we will specify bwtsw as the indexing option (as indicated by the "Warning" message), and the name of the FASTA file is sacCer3.fa.
The output of this command is a group of files that are all required together as the index. So, within our references directory, we will create another directory called references/bwa/sacCer3 and build the index there. To remind ourselves which FASTA was used to build the index, we create a symbolic link to our references/fasta/sacCer3.fa file (note the use of the ../.. relative path syntax).
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/references/bwa/sacCer3
cd $SCRATCH/core_ngs/references/bwa/sacCer3
ln -sf ../../fasta/sacCer3.fa
ls -l |
Now execute the bwa index command.
Code Block | ||||
---|---|---|---|---|
| ||||
bwa index -a bwtsw sacCer3.fa |
Since the yeast genome is not large when compared to human, this should not take long to execute (otherwise we would do it as a batch job). When it is complete you should see a set of index files like this:
Code Block | ||
---|---|---|
| ||
sacCer3.fa
sacCer3.fa.amb
sacCer3.fa.ann
sacCer3.fa.bwt
sacCer3.fa.pac
sacCer3.fa.sa |
Performing the bwa alignment
Now, we're ready to execute the actual alignment, with the goal of initially producing a SAM file from the input FASTQ files and reference. First prepare a directory for this exercise and link the sacCer3 reference directories there (this will make our commands more readable).
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/alignment/yeast_bwa
cd $SCRATCH/core_ngs/alignment/yeast_bwa
ln -sf ../fastq
ln -sf ../../references/bwa/sacCer3 |
As our workflow indicated, we first use bwa aln on the R1 and R2 FASTQs, producing a BWA-specific .sai intermediate binary files.
What does bwa aln needs in the way of arguments?
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Required arguments are a <prefix> of the bwa index files, and the input FASTQ file. There are lots of options, but here is a summary of the most important ones.
Option | Effect |
---|---|
-l | Specifies the length of the seed (default = 32) |
-k | Specifies the number of mismatches allowable in the seed of each alignment (default = 2) |
-n | Specifies the number of mismatches (or fraction of bases in a given alignment that can be mismatches) in the entire alignment (including the seed) (default = 0.04) |
-t | Specifies the number of threads |
Other options control the details of how much a mismatch or gap is penalized, limits on the number of acceptable hits per read, and so on. Much more information can be found on the BWA manual page.
For a basic alignment like this, we can just go with the default alignment parameters.
Note that bwa writes its (binary) output to standard output by default, so we need to redirect that to a .sai file.
For simplicity, we will just execute these commands directly, one at a time. Each command should only take few minutes and you will see bwa's progress messages in your terminal.
Code Block |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p $SCRATCH/core_ngs/alignment/yeast_bwa
cd $SCRATCH/core_ngs/alignment/yeast_bwa
ln -s -f ../fastq
ln -s -f ../../references/bwa/sacCer3 |
As our workflow indicated, we first use bwa aln on the R1 and R2 FASTQs, producing a BWA-specific .sai intermediate binary files.
What does bwa aln needs in the way of arguments?
...
title | Hint |
---|
Code Block | ||
---|---|---|
| ||
bwa aln |
There are lots of options, but here is a summary of the most important ones.
...
Other options control the details of how much a mismatch or gap is penalized, limits on the number of acceptable hits per read, and so on. Much more information can be found on the BWA manual page.
For a basic alignment like this, we can just go with the default alignment parameters.
Note that bwa writes its (binary) output to standard output by default, so we need to redirect that to a .sai file.
For simplicity, we will just execute these commands directly, one at a time. Each command should only take few minutes and you will see bwa's progress messages in your terminal.
Code Block | ||||
---|---|---|---|---|
| ||||
| ||||
bwa index -a bwtsw sacCer3.fa |
Since the yeast genome is not large when compared to human, this should not take long to execute (otherwise we would do it as a batch job). When it is complete you should see a set of index files like this:
Code Block | ||
---|---|---|
| ||
sacCer3.fa
sacCer3.fa.amb
sacCer3.fa.ann
sacCer3.fa.bwt
sacCer3.fa.pac
sacCer3.fa.sa |
Performing the bwa alignment
Now, we're ready to execute the actual alignment, with the goal of initially producing a SAM file from the input FASTQ files and reference. First prepare a directory for this exercise and link the sacCer3 reference directories there (this will make our commands more readable).
...
title | Setup (if needed) |
---|
Code Block | ||
---|---|---|
| ||
# Copy the pre-built references
mkdir -p $SCRATCH/core_ngs/references
cp $CORENGS/references/*.fa $SCRATCH/core_ngs/references/fasta/
# Get the FASTQ to align
mkdir -p $SCRATCH/core_ngs/alignment/fastq
cp $CORENGS/alignment/*fastq.gz $SCRATCH/core_ngs/alignment/fastq/
|
| |
# If not already loaded:
module load biocontainers
module load bwa
cd $SCRATCH/core_ngs/alignment/yeast_bwa
bwa aln sacCer3/sacCer3.fa fastq/Sample_Yeast_L005_R1.cat.fastq.gz > yeast_pe_R1.sai
bwa aln sacCer3/sacCer3.fa fastq/Sample_Yeast_L005_R2.cat.fastq.gz > yeast_pe_R2.sai |
When all is done you should have two .sai files: yeast_pe_R1.sai and yeast_pe_R2.sai.
Tip | ||
---|---|---|
| ||
Double check that output was written by doing ls -lh and making sure the file sizes listed are not 0. |
Exercise: How long did it take to align the R2 file?
Expand | |||||
---|---|---|---|---|---|
| |||||
The last few lines of bwa's execution output should look something like this:
So the R2 alignment took ~85 seconds (~1.4 minutes). |
Since you have your own private compute node, you can use all its resources. It has 128 cores, so re-run the R2 alignment asking for 60 execution threads.
Code Block |
---|
bwa aln -t 60 sacCer3/sacCer3.fa fastq/Sample_Yeast_L005_R2.cat.fastq.gz > yeast_R2.sai |
...
pe_R2.sai |
...
Tip | |
---|---|
Make sure your output files are not empty | |
Double check that output was written by doing ls -lh and making sure the file sizes listed are not 0. |
Exercise: How long did it take to align much of a speedup did you seen when aligning the R2 file with 60 threads?
Expand | ||
---|---|---|
| ||
The last few lines of bwa's execution output should look something like this: Code Block | | |
|
Code Block | ||
---|---|---|
| ||
[bwa_aln] 190bp17bp reads: max_diff = 82 [bwa_aln] 225bp38bp reads: max_diff = 9 [bwa_aln_core] calculate SA coordinate... 50.76 sec [bwa_aln_core] write to the disk... 0.07 sec [bwa_aln_core] 262144 sequences have been processed. [bwa_aln_core] calculate SA coordinate... 50.35 sec 3 [bwa_aln_core] write64bp to the disk... 0.07 sec reads: max_diff = 4 [bwa_aln_core] 52428893bp sequences have been processed.reads: max_diff = 5 [bwa_aln_core] calculate124bp SA coordinate... 13.64 secreads: max_diff = 6 [bwa_aln_core] write157bp to the disk... 0.01 sec reads: max_diff = 7 [bwa_aln_core] 592180190bp sequences have been processed. [main] Version: 0.7.17-r1188 [main] CMD: /usr/local/bin/bwa aln sacCer3/sacCer3.fa fastq/Sample_Yeast_L005_R1.cat.fastq.gz [main] Real time: 78.185 sec; CPU: 77.598 sec |
So the R2 alignment took ~78 seconds (~1.3 minutes).
Since you have your own private compute node, you can use all its resources. It has 128 cores, so re-run the R2 alignment asking for 60 execution threads.
Code Block |
---|
bwa aln -t 60 sacCer3/sacCer3.fa fastq/Sample_Yeast_L005_R2.cat.fastq.gz > yeast_R2.sai |
Exercise: How much of a speedup did you seen when aligning the R2 file with 20 threads?
Expand | |||||
---|---|---|---|---|---|
| |||||
The last few lines of bwa's execution output should look something like this:
So the R2 alignment took only ~5 seconds (real time), or 15+ times as fast as with only one processing thread. Note, though, that the CPU time with 60 threads was greater (142.8 sec) than with only 1 thread (77.6 sec). That's because of the thread management overhead when using multiple threads. |
Next we use the bwa sampe command to pair the reads and output SAM format data. Just type that command in with no arguments to see its usage.
For this command you provide the same reference index prefix as for bwa aln, along with the two .sai files and the two original FASTQ files. Also, bwa writes its output to standard output, so redirect that to a .sam file.
Here is the command line statement you need. Just execute it on the command line.
Code Block | ||||
---|---|---|---|---|
| ||||
bwa sampe sacCer3/sacCer3.fa yeast_R1.sai yeast_R2.sai \
fastq/Sample_Yeast_L005_R1.cat.fastq.gz \
fastq/Sample_Yeast_L005_R2.cat.fastq.gz > yeast_pairedend.sam |
...
So the R2 alignment took only ~8 seconds (real time), or 10+ times as fast as with only one processing thread. Note, though, that the CPU time with 60 threads was greater (~180 sec) than with only 1 thread (~85 sec). That's because of the thread management overhead when using multiple threads. |
Next we use the bwa sampe command to pair the reads and output SAM format data. Just type that command in with no arguments to see its usage.
For this command you provide the same reference index prefix as for bwa aln, along with the two .sai files and the two original FASTQ files. Also, bwa writes its output to standard output, so redirect that to a .sam file.
Here is the command line statement you need. Just execute it on the command line.
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
cd $SCRATCH/core_ngs/alignment/yeast_bwa
bwa sampe sacCer3/sacCer3.fa yeast_pe_R1.sai yeast_pe_R2.sai \
fastq/Sample_Yeast_L005_R1.cat.fastq.gz \
fastq/Sample_Yeast_L005_R2.cat.fastq.gz > yeast_pe.sam |
You should now have a SAM file (yeast_pe.sam) that contains the alignments.
Exercise: How many lines does the SAM file have? How does this compare to the number of input sequences (R1+R2)?
Expand | ||
---|---|---|
| ||
wc -l yeast_pe.sam reports 1,184,378 lines The alignment SAM file will contain records for both R1 and R2 reads, so we need to count sequences in both files. zcat ./fastq/Sample_Yeast_L005_R[12]*gz | wc -l | awk '{print $1/4}' reports 1,184,360 reads that were aligned So the SAM file has 18 more lines than the R1+R2 total. These are the header records that appear before any alignment records. |
It's just a text file, so take a look with head, more, less, tail, or whatever you feel like. Later you'll learn additional ways to analyze the data with samtools once you create a BAM file.
...
Exercise: How many alignment records (not header records) are in the SAM file?
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Expand | ||||||||||
| ||||||||||
This looks for the pattern '^HWI' which is the start of every read name (which starts every alignment record).
Or use the -v (invert) option to tell grep to print all lines that don't match a particular pattern; here, all header lines, which start with @.
|
Expand | ||
---|---|---|
| ||
There are 1,184,360 alignment records. |
Exercise: How many sequences were in the R1 and R2 FASTQ files combined?
zcat fastq/Sample_Yeast_L005_R[12].cat.fastq.gz | wc -l | awk '{print $1/4}'@.
|
Expand | ||
---|---|---|
| ||
There were a total of are 1,184,360 original sequences (R1s + R2s)alignment records. |
Exercises:
...
- Does the SAM file contain both mapped and un-mapped reads?
- What is the order of the alignment records in this SAM file?
Expand | ||
---|---|---|
| ||
Both R1 and R2 reads must have separate alignment records, because there were 1,184,360 R1+R2 reads and the same number of alignment records. The SAM file must contain both mapped and un-mapped reads, because there were 1,184,360 R1+R2 reads and the and the same number of alignment records. Alignment records occur in the same read-name order as they did in the FASTQ, except that they come in pairs. The R1 read comes 1st, then the corresponding R2. This is called read name ordering. |
...
Suppose you wanted to look only at field 3 (contig name) values in the SAM file. You can do this with the handy cut command. Below is a simple example where you're asking cut to display the 3rd column value for the last 10 alignment records.
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
tail yeast_pairedendpe.sam | cut -f 3 |
By default cut assumes the field delimiter is Tab, which is the delimiter used in the majority of NGS file formats. You can specify a different delimiter with the -d option.
...
Code Block | ||||
---|---|---|---|---|
| ||||
tail -20 yeast_pairedendpe.sam | cut -f 2-6,9 |
You may have noticed that some alignment records contain contig names (e.g. chrV) in field 3 while others contain an asterisk ( * ). The * means the record didn't map. We're going to use this heuristic along with cut to see about how many records represent aligned sequences. (Note this is not the strictly correct method of finding unmapped reads because not all unmapped reads have an asterisk in field 3. Later you'll see how to properly distinguish between mapped and unmapped reads using samtools.)
...
Code Block | ||||
---|---|---|---|---|
| ||||
# the ^@ pattern matches lines starting with @ (only header lines), # and -v says output lines that don't match grep -v -P '^@' yeast_pairedendpe.sam | head |
Ok, it looks like we're seeing only alignment records. Now let's pull out only field 3 using cut:
...
Code Block | ||||
---|---|---|---|---|
| ||||
grep -v -P '^@' yeast_pairedendpe.sam | cut -f 3 | grep -v '*' | head |
...
Code Block | ||||
---|---|---|---|---|
| ||||
grep -v -P '^@' yeast_pairedendpe.sam | cut -f 3 | grep -v '*' | wc -l |
Read more at Some Linux commands: Advanced commands
Exercise: About how many records represent aligned sequences? What alignment rate does this represent?
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
The expression above returns 612,968. There were 1,184,360 records total, so the percentage is:
or about 51%. Not great. Note we perform this calculation in awk's BEGIN block, which is always executed, instead of the body block, which is only executed for lines of input. And here we call awk without piping it any input. See Linux fundamentals: cut,sort,uniq,grep,awkwe call awk without piping it any input. |
Exercise: What might we try in order to improve the alignment rate?
...
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Code Block | ||
---|---|---|
| ||
# If not already loaded module load biocontainers # takes a while module load samtools samtools |
...
In this exercise, we will explore five utilities provided by samtools: view, sort, index, flagstat, and idxstats. Each of these is executed in one line for a given SAM/BAM file. In the SAMtools/BEDtools sections tomorrow we will explore samtools in capabilities more in depth.
Warning | ||
---|---|---|
| ||
There are two main "eras" of SAMtools development:
Unfortunately, some functions with the same name in both version eras have different options and arguments! So be sure you know which version you're using. (The samtools version is usually reported at the top of its usage listing). TACC BioContainers also offers the original samtools version: samtools/ctr-0.1.19--3. |
...
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
cd $SCRATCH/core_ngs/alignment/yeast_bwa cat yeast_pairedend.sam | samtools view -b -o yeast_pe.sam > yeast_pairedendpe.bam |
- the -b option tells the tool to output BAM format
- the -o option specifies the name of the output BAM file that will be created
- we pipe the entire SAM file to samtools view so that the header records are included (required for SAM → BAM conversion)
- samtools view reads its input from standard input by default
...
- the tool to output BAM format
The BAM file is a binary file, not a text file, so how do you look at its contents now? Just use samtools view without the -b option. Remember to pipe output to a pager!
Code Block | ||||
---|---|---|---|---|
| ||||
samtools view yeast_pairedendpe.bam | more |
Notice that this does not show us the header record we saw at the start of the SAM file.Exercise: What samtools view option will include the header records in its output? Which option would show only the header records?we saw at the start of the SAM file.
Exercise: What samtools view option will include the header records in its output? Which option would show only the header records?
Expand | ||
---|---|---|
| ||
Note that samtools (like bwa) writes its help to standard error, but less and more only accept input on standard input. So the syntax redirecting standard error to standard input must be used before the pipe to less or more. samtools view 2>&1 | less then search for "header" ( /header ) |
Expand | ||
---|---|---|
| ||
samtools view -h shows header records along with alignment records. samtools view -H shows header records only. |
...
Looking at some of the alignment record information (e.g. samtools view yeast_pairedendpe.bam | cut -f 1-4 | more), you will notice that read names appear in adjacent pairs (for the R1 and R2), in the same order they appeared in the original FASTQ file. Since that means the corresponding mappings are in no particular order, searching through the file very inefficient. samtools sort re-orders entries in the SAM file either by locus (contig name + coordinate position) or by read name.
...
Expand | |||||
---|---|---|---|---|---|
| |||||
Copy aligned yeast BAM file
|
To sort the paired-end yeast BAM file by position, and get a BAM file named yeast_pairedendpe.sort.bam as output, execute the following command:
Code Block | ||||
---|---|---|---|---|
| ||||
cd $SCRATCH/core_ngs/alignment/yeast_bwa samtools sort -O bam -T yeast_pairedendpe.tmp yeast_pairedendpe.bam > yeast_pairedendpe.sort.bam |
- The -O options says the Output format should be BAM
- The -T options gives a prefix for Temporary files produced during sorting
- sorting large BAMs will produce many temporary files during processingduring processing
- make sure the temporary file prefix is different from the input BAM file prefix!
- By default sort writes its output to standard output, so we use > to redirect to a file named yeast_pairedend.sort.bam
Exercise: Compare the file sizes of the yeast_pariedend pe .sam, .bam, and .sort.bam files and explain why they are different.
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||
---|---|---|
| ||
The yeast_pairedendpe.sam text file is the largest at ~348 MB because it is an uncompressed text file. The name-ordered binary yeast_pairedendpe.bam text file only about 1/3 that size, ~111 MB. They contain exactly the same records, in the same order, but conversion from text to binary results in a much smaller file. The coordinate-ordered binary yeast_pairedendpe.sort.bam file is even slightly smaller, ~92 MB. This is because BAM files are actually customized gzip-format files. The customization allows blocks of data (e.g. all alignment records for a contig) to be represented in an even more compact form. You can read more about this in section 4 of the SAM format specification. |
...
Code Block | ||||
---|---|---|---|---|
| ||||
samtools index yeast_pairedendpe.sort.bam |
This will produce a file named yeast_pairedendpe.bam.bai.
Most of the time when an index is required, it will be automatically located as long as it is in the same directory as its BAM file and shares the same name up until the .bai extension.
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||
---|---|---|
| ||
While the yeast_pairedendpe.sort.bam file is ~92 MB, its index (yeast_pairedendpe.sort.bai) is only 20 KB. |
samtools flagstat
...
Here's how to run samtools flagstat and both see the output in the terminal and save it in a file – the samtools flagstat standard output is piped to tee, which both writes it to the specified file and sends it to its standard output:it to the specified file and sends it to its standard output:
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
samtools flagstat yeast_pairedendpe.sort.bam | tee yeast_pariedendpe.flagstat.txt |
You should see something like this:
...
More information about the alignment is provided by the samtools idxstats report, which shows how many reads aligned to each contig in your reference. Note that samtools idxstats must be run on a sorted, indexed BAM file.
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
samtools idxstats yeast_pairedendpe.sort.bam | tee yeast_pairedendpe.idxstats.txt |
Here we use the tee command which reports its standard input outputto standard output before also writing it to the specified file.
...