More Alignment exercises
Reservations
Use Thursday's reservation (core-ngs-class-0605) when submitting batch jobs to get higher priority on the ls6 normal queue.
Request an interactive (idev) node
# Request a 180 minute interactive node on the normal queue using our reservation
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0605 # Thursday
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0606 # Friday
# or: request a 120 minute idev node on the development queue
idev -m 120 -N 1 -A OTH21164 -p development
Submit a batch job
sbatch --reservation=core-ngs-class-0605 <batch_file>.slurm # Thursday
sbatch --reservation=core-ngs-class-0606 <batch_file>.slurm # FridayNote that the reservation name (core-ngs-class-0605) is different from the TACC allocation/project for this class, which is OTH21164.
Exercise #3: PE alignment with BioITeam scripts
Now that you've done everything the hard way, let's see how to do run an alignment pipeline using a BWA alignment script maintained by the BioITeam, /work/projects/BioITeam/common/script/align_bwa_illumina.sh. Type in the script name to see its usage.
align_bwa_illumina.sh 2022_06_10
Align Illumina SE or PE data with bwa. Produces a sorted, indexed,
duplicate-marked BAM file and various statistics files. Usage:
align_bwa_illumina.sh <aln_mode> <in_file> <out_pfx> <assembly> [paired trim_sz trim_sz2 seq_fmt qual_fmt]
Required arguments:
aln_mode Alignment mode, either global (bwa aln) or local (bwa mem).
in_file For single-end alignments, path to input sequence file.
For paired-end alignments using fastq, path to the the R1
fastq file which must contain the string 'R1' in its name.
The corresponding 'R2' must have the same path except for 'R1'.
out_pfx Desired prefix of output files in the current directory.
assembly One of hg38, hg19, hg38, mm10, mm9, sacCer3, sacCer1, ce11, ce10,
danRer7, hs_mirbase, mm_mirbase, or reference index prefix.
Optional arguments:
paired 0 = single end alignment (default); 1 = paired end.
trim_sz Size to trim reads to. Default 0 (no trimming)
trim_sz2 Size to trim R2 reads to for paired end alignments.
Defaults to trim_sz
seq_fmt Format of sequence file (fastq, bam or scarf). Default is
fastq if the input file has a '.fastq' extension; scarf
if it has a '.sequence.txt' extension.
qual_type Type of read quality scores (sanger, illumina or solexa).
Default is sanger for fastq, illumina for scarf.
Environment variables:
show_only 1 = only show what would be done (default not set)
aln_args other bowtie2 options (e.g. '-T 20' for mem, '-l 20' for aln)
no_markdup 1 = don't mark duplicates (default 0, mark duplicates)
run_fastqc 1 = run fastqc (default 0, don't run). Note that output
will be in the directory containing the fastq files.
keep 1 = keep unsorted BAM (default 0, don't keep)
bwa_bin BWA binary to use. Default bwa 0.7.x. Note that bwa 0.6.2
or earlier should be used for scarf and other short reads.
also: NUM_THREADS, BAM_SORT_MEM, SORT_THREADS, JAVA_MEM_ARG
Examples:
align_bwa_illumina.sh local ABC_L001_R1.fastq.gz my_abc hg38 1
align_bwa_illumina.sh global ABC_L001_R1.fastq.gz my_abc hg38 1 50
align_bwa_illumina.sh global sequence.txt old sacCer3 0 '' '' scarf solexaThere are lots of bells and whistles in the arguments, but the most important are the first few:
aln_mode – whether to perform a global or local alignment (the 1st argument must be one of those words)
global mode uses the bwa aln workflow as we did above
local mode uses the bwa mem command
in_file – full or relative path to the FASTQ file (just the R1 fastq if paired end). Can be compressed (.gz)
out_pfx – prefix for all the output files produced by the script. Should relate back to what the data is.
assembly – genome assembly to use.
there are pre-built indexes for some common eukaryotes (hg38, hg19, mm10, mm9, danRer7, sacCer3) that you can use
or provide a full path for a bwa reference index you have built somewhere
paired flag – 0 means single end (the default); 1 means paired end
trim_sz – if you want the FASTQ hard trimmed down to a specific length before alignment, supply that number here
We're going to run this script and a similar Bowtie2 alignment script, on the yeast data using the TACC batch system. In a new directory, copy over the commands and submit the batch job. We ask for 2 hours (-t 02:00:00) with 4 tasks/node (-w 4); since we have 4 commands, this will run on 1 compute node.
Run multiple alignments using the TACC batch system
# Make sure you're not in an idev session by looking at the hostname
hostname
# If the hostname looks like "c455-004.ls6.tacc.utexas.edu", exit the idev session
# Copy over the Yeast data if needed
mkdir -p $SCRATCH/core_ngs/alignment/fastq
cp $CORENGS/alignment/Sample_Yeast*.gz $SCRATCH/core_ngs/alignment/fastq/
# Make a new alignment directory for running these scripts
mkdir -p $SCRATCH/core_ngs/alignment/aln_script
cd $SCRATCH/core_ngs/alignment/aln_script
ln -sf ../fastq
# Copy the alignment commands file and submit the batch job
cd $SCRATCH/core_ngs/alignment/aln_script
cp $CORENGS/tacc/aln_script.cmds .
launcher_creator.py -j aln_script.cmds -n aln_script -t 02:00:00 -w 4 \
-a OTH21164 -q normal -m 'module unload xalt'
sbatch --reservation=core-ngs-class-0605 aln_script.slurm # Thursday
sbatch --reservation=core-ngs-class-0606 aln_script.slurm # Friday
# or, without reservation:
launcher_creator.py -j aln_script.cmds -n aln_script -t 02:00:00 -w 4 \
-a OTH21164 -q development -m 'module unload xalt'
sbatch aln_script.slurm
showq -uWhile we're waiting for the job to complete, lets look at the aln_script.cmds file.
Commands to run multiple alignment scripts
/work/projects/BioITeam/common/script/align_bwa_illumina.sh global ./fastq/Sample_Yeast_L005_R1.cat.fastq.gz bwa_global sacCer3 1 50
/work/projects/BioITeam/common/script/align_bwa_illumina.sh local ./fastq/Sample_Yeast_L005_R1.cat.fastq.gz bwa_local sacCer3 1
/work/projects/BioITeam/common/script/align_bowtie2_illumina.sh global ./fastq/Sample_Yeast_L005_R1.cat.fastq.gz bt2_global sacCer3 1 50
/work/projects/BioITeam/common/script/align_bowtie2_illumina.sh local ./fastq/Sample_Yeast_L005_R1.cat.fastq.gz bt2_local sacCer3 1Notes:
The 1st command performs a paired-end BWA global alignment (similar to above), but asks that the 100 bp reads be trimmed to 50 first.
we refer to the prebuilt index for yeast by name: sacCer3
this index is located in the /work/projects/BioITeam/ref_genome/bwa/bwtsw/sacCer3/ directory
we provide the name of the R1 FASTQ file
because we request a PE alignment (the 1 argument) the script will look for a similarly-named R2 file.
all output files associated with this command will be named with the prefix bwa_global.
The 2nd command performs a paired-end BWA local alignment.
all output files associated with this command will be named with the prefix bwa_local.
no trimming is requested because the local alignment should ignore 5' and 3' bases that don't match the reference genome
The 3rd command performs a paired-end Bowtie2 global alignment.
the Bowtie2 alignment script has similar arguments to the BWA alignment script.
again, we specify that reads should first be trimmed to 50 bp.
all output files associated with this command will be named with the prefix bt2_global.
The 4th command performs a paired-end Bowtie2 local alignment.
all output files associated with this command will be named with the prefix bt2_local.
again, no trimming is requested for the local alignment.
Output files
This alignment pipeline script performs the following steps:
Hard trims FASTQ, if optionally specified (fastx_trimmer)
Performs the global or local alignment (here, a PE alignment)
BWA global: bwa aln the R1 and R2 separately, then bwa sampe to produce a SAM file
BWA local: call bwa mem with both R1 and R2 to produce a SAM file
Bowtie2 global: call bowtie2 in its default global (end-to-end) mode on both R1 and R2 to produce a SAM file
Bowtie2 local: call bowtie2 --local with both R1 and R2 to produce a SAM file
Converts SAM to BAM (samtools view)
Sorts the BAM (samtools sort)
Marks duplicates (Picard MarkDuplicates)
Indexes the sorted, duplicate-marked BAM (samtools index)
Gathers statistics (samtools idxstats, samtools flagstat, plus a custom statistics script of Anna's)
Removes intermediate files
There are a number of output files, with the most important being those desribed below.
<prefix>.align.log – Log file of the entire alignment process.
check the tail of this file to make sure the alignment was successful
<prefix>.sort.dup.bam – Sorted, duplicate-marked alignment file.
<prefix>.sort.dup.bam.bai – Index for the sorted, duplicate-marked alignment file
<prefix>.flagstat.txt – samtools flagstat output
<prefix>.idxstats.txt – samtools idxstats output
<prefix>.samstats.txt – Summary alignment statistics from Anna's stats script
<prefix>.iszinfo.txt – Insert size statistics (for paired-end alignments) from Anna's stats script
Verifying alignment success
The alignment log will have a "I ran successfully" message at the end if all went well, and if there was an error, the important information should also be at the end of the log file. So you can use tail to check the status of an alignment. For example:
Checking the alignment log file
tail bt2_local.align.logThis will show something like:
------------------------------------------------------------------
..Done: alignmentUtils.pl bamstats - 2025-05-30 14:44:02
.. samstats file 'bt2_local.samstats.txt' exists and is not empty - 2025-05-30 14:44:02
===============================================================================
## Cleaning up files (keep 0) - 2025-05-30 14:44:02
===============================================================================
ckRes 0 cleanup
===============================================================================
## All bowtie2 alignment tasks completed successfully! - 2025-05-30 14:44:02
===============================================================================Notice that success message: "All bowtie2 alignment tasks completed successfully!". It should only appear once in any successful alignment log file.
When multiple alignment commands are run in parallel it is important to check them all, and you can use grep looking for part of the unique success message to do this. For example:
Count the number of successful alignments
grep 'completed successfully!' *align.log | wc -lIf this command returns 4 (the number of alignment tasks we performed), all went well, and we're done. Another way is to list all the filenames that contain that pattern using grep -l:
Which alignments completed successfully?
grep -l 'completed successfully!' *align.logBut what if something went wrong? How can we tell which alignment task was not successful? You could tail the log files one by one to see which one(s) don't have the message, but you can also use the special grep -L option to do this work.
Check for failed alignments
grep -L 'completed successfully' *.align.logThe -L option tells grep to only print the filenames that don't contain the pattern. Perfect! To see happens in the case of failure, try it on files that don't contain that message:
grep -L 'completed successfully' *.samstats.txtChecking alignment statistics
The <prefix>.samstats.txt statistics files produced by the alignment pipeline has a lot of good information in one place. If you look at bwa_global.samstats.txt you'll see something like this:
<prefix>.samstats.txt output
-----------------------------------------------
Aligner: bwa
Total sequences: 1184360
Total mapped: 539079 (45.5 %)
Total unmapped: 645281 (54.5 %)
Primary: 539079 (100.0 %)
Secondary:
Duplicates: 249655 (46.3 %)
Fwd strand: 267978 (49.7 %)
Rev strand: 271101 (50.3 %)
Unique hit: 503629 (93.4 %)
Multi hit: 35450 (6.6 %)
Soft clip:
All match: 531746 (98.6 %)
Indels: 7333 (1.4 %)
Spliced:
-----------------------------------------------
Total PE seqs: 1184360
PE seqs mapped: 539079 (45.5 %)
Num PE pairs: 592180
F5 1st end mapped: 372121 (62.8 %)
F3 2nd end mapped: 166958 (28.2 %)
PE pairs mapped: 80975 (13.7 %)
PE proper pairs: 16817 (2.8 %)
-----------------------------------------------Since this was a paired end alignment there is paired-end specific information reported. Note that this Yeast dataset was of poor quality, especially the R2 reads. You can see this by the relatively low R1 alignment rate (~63%) and the really low R2 alignment rate (~28%).
A quick way to check alignment stats if you have run multiple alignments is again to use grep. For example:
Review multiple alignment rates
grep 'Total mapped' *samstats.txtwill produce output like this:
bt2_global.samstats.txt: Total mapped: 602893 (50.9 %)
bt2_local.samstats.txt: Total mapped: 788069 (66.5 %)
bwa_global.samstats.txt: Total mapped: 539079 (45.5 %)
bwa_local.samstats.txt: Total mapped: 1008000 (76.5 %You can also view statistics on insert sizes for properly paired reads in the bwa_global.iszinfo.txt file. This tells you the average (mean) insert size, standard deviation, mode (most common value), and fivenum values (minimum, 1st quartile, median, 3rd quartile, maximum).
<prefix>.iszinfo.txt output
Insert size stats for: bwa_global
Number of pairs: 16807 (proper)
Number of insert sizes: 406
Mean [-/+ 1 SD]: 296 [176 416] (sd 120)
Mode [Fivenum]: 228 [51 224 232 241 500]Exercise: How would you list the median insert size for all the alignments?
TACC batch system considerations
The great thing about pipeline scripts like this is that you can perform alignments on many datasets in parallel at TACC, and they are written to take advantage of having multiple cores on TACC nodes where possible.
On the ls6 the pipeline scripts are designed to run best with 4 tasks per node. Although each ls6 node has 128 physical cores per node, the alignment workflow is heavily I/O bound overall, and we don't want to overload the file system.
Always specify wayness 4 for alignment pipeline scripts
These alignment scripts should always be run with a wayness of 4 (-w 4) in the ls6 batch system, meaning at most 4 commands per node.
Exercise #4: Bowtie2 alignment - Vibrio cholerae RNA-seq
While we have focused on aligning eukaryotic data, the same tools can be used with prokaryotic data. The major differences are less about the underlying data and much more about the external/public databases that store and distribute reference data. If we want to study a prokaryote, the reference data is usually downloaded from a resource like GenBank.
In this exercise, we will use some RNA-seq data from Vibrio cholerae, published on GEO here, and align it to a reference genome.
Overview of Vibrio cholerae alignment workflow with Bowtie2
Alignment of this prokaryotic data follows the workflow below. Here we will concentrate on steps 1 and 2.
Obtain reference FASTA for vibCho from NCBI GenBank records
Prepare the vibCho reference index for bowtie2 from the GenBank FASTA
Align reads using bowtie2, producing a SAM file
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)
Obtaining the GenBank records
First prepare a directory for the vibCho fasta, and change to it:
mkdir -p $SCRATCH/core_ngs/references/fasta
cd $SCRATCH/core_ngs/references/fastaTo look for a Genome at NCBI, navigate to: https://www.ncbi.nlm.nih.gov/datasets/genome/
Enter Vibrio cholerae as the Search term
The first assembly listed is ASM836960v1
It has a checkmark beside it, meaning this is the "preferred" Genome
Click on the ASM836960v1 link
Takes you to the Genome assembly ASM836960v1 page
Click on the FTP link
Right click on the GCF_008369605.1_ASM836960v1_genomic.fna.gz link and Copy link address
In your $SCRATCH/core_ngs/references/fasta directory, type wget then Paste
you should see:
wgethttps://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/008/369/605/GCF_008369605.1_ASM836960v1/GCF_008369605.1_ASM836960v1_genomic.fna.gzPress Enter
You should see the file GCF_008369605.1_ASM836960v1_genomic.fna.gz.
Go back to the FTP page
Right click on the GCF_008369605.1_ASM836960v1_genomic.gtf.gz link and Copy link address
In your $SCRATCH/core_ngs/references/fasta directory, type wget then Paste
you should see:
wgethttps://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/008/369/605/GCF_008369605.1_ASM836960v1/GCF_008369605.1_ASM836960v1_genomic.gtf.gzPress Enter
You should see the file GCF_008369605.1_ASM836960v1_genomic.gtf.gz.
Unzip and rename the two GZIP files:
cd $SCRATCH/core/ngs/references/fastagunzip GCF_008369605.1_ASM836960v1_genomic.fna.gz > vibCho_ASM836960v1.fnagunzip GCF_008369605.1_ASM836960v1_genomic.gtf.gz> vibCho_ASM836960v1.gtf
Exercise: How many contigs are in the Vibrio cholerae FASTQ reference genome?
Now we have a reference sequence file that we can use with the bowtie2 reference builder, and ultimately align sequence data against.
Introducing bowtie2
First make sure you're in an idev session:
Start an idev session
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0605 # Thursday
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0606 # Friday
# or, without a reservation:
idev -m 120 -A OTH21164 -N 1 -p development Go ahead and load the bowtie2 module so we can examine some help pages and options.
module load biocontainers
module load bowtie2
Now that it's loaded, check out the options (bowtie2 --help | more). There are a lot of them! In fact for the full range of options and their meaning, Google "Bowtie2 manual" and bring up that page (http://bowtie-bio.sourceforge.net/bowtie2/manual.shtml). The Table of Contents is several pages long! Ouch!
This is the key to using bowtie2 - it allows you to control almost everything about its behavior, which make it the go-to aligner for specialized alignment tasks (e.g. aligning miRNA or other small reads). But it also makes it is much more challenging to use than bwa – and it's easier to screw things up too!
Building the bowtie2 vibCho index
Before the alignment, of course, we've got to build a bowtie2- specific index using bowtie2-build. Go ahead and check out its options.
Usage: bowtie2-build [options]* <reference_in> <bt2_index_base>Unlike for the aligner itself, we only need to worry about a few things here:
reference_in file is just the vibCho_ASM836960v1.fna FASTA from GenBank records
bt2_index_base is the prefix of all the bowtie2-build output file
To build the reference index for alignment we only need the FASTA file, and a prefix that we want all the output files to have.
First create a directory specifically for the bowtie2 index, then build the index using bowtie-build.
Prepare Bowtie2 index files for vibCho
mkdir -p $SCRATCH/core_ngs/references/bt2/vibCho
cd $SCRATCH/core_ngs/references/bt2/vibCho
# Symlink to the fasta file you created using relative path syntax
ln -sf ../../fasta/vibCho_ASM836960v1.fna
bowtie2-build vibCho_ASM836960v1.fna vibCho_ASM836960v1This should also go pretty fast. You can see the resulting files using ls like before.
Performing the bowtie2 alignment
Make sure you're in an idev session with the bowtie2 BioContainers module loaded:
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0605 # Thursday
idev -m 120 -N 1 -A OTH21164 -r core-ngs-class-0606 # Friday
# or, without a reservation:
idev -m 120 -A OTH21164 -N 1 -p development
module load biocontainers
module load bowtie2We'll set up a new directory to perform the V. cholerae data alignment. But first make sure you have the FASTQ file to align and the vibCho bowtie2 index.
# Get a pre-built vibCho index if you didn't already build one
mkdir -p $SCRATCH/core_ngs/references/bt2/vibCho
cp $CORENGS/references/bt2/vibCho/*.* $SCRATCH/core_ngs/references/bt2/vibCho/
# Get the FASTQ to align
mkdir -p $SCRATCH/core_ngs/alignment/fastq
cp $CORENGS/alignment/*fastq.gz $SCRATCH/core_ngs/alignment/fastq/
ls $SCRATCH/core_ngs/alignment/fastqNow set up a directory to do this alignment, with symbolic links to the bowtie2 index directory and the directory containing the FASTQ to align:
mkdir -p $SCRATCH/core_ngs/alignment/vibCho
cd $SCRATCH/core_ngs/alignment/vibCho
# symlink the bowtie2 Vibrio reference and FASTQ directories
ln -sf ../../references/bt2/vibCho
ln -sf ../../alignment/fastq fqWe'll be aligning the V. cholerae reads now in ./fq/cholera_rnaseq.fastq.gz (how many sequences does it contain?)
Exercise: How many sequences does the ./fq/cholera_rnaseq.fastq.gz file contain?
Note that here the data is from standard mRNA sequencing, meaning that the DNA fragments are typically longer than the reads. There is likely to be very little contamination that would require using a local rather than global alignment, or many other preprocessing steps (e.g. adapter trimming). Thus, we will run bowtie2 with default parameters, omitting options other than the input, output, and reference index. This performs a global alignment.
As you can tell from looking at the bowtie2 help message, the general syntax looks like this:
bowtie2 [options]* -x <bt2-idx> {-1 <m1> -2 <m2> | -U <r>} [-S <sam>]So execute this bowtie2 global, single-end alignment command:
cd $SCRATCH/core_ngs/alignment/vibCho
bowtie2 -x vibCho/vibCho_ASM836960v1 -U fq/cholera_rnaseq.fastq.gz \
-S cholera_rnaseq.sam 2>&1 | tee aln_global.logNotes: