Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Before you start the alignment and analysis processes, it can be useful to perform some initial quality checks on your raw data. If you don't do this (or even if you do), you may notice later that something looks fishy in the the output: for example, many of your reads are not mapping or the ends of many of your reads do not align. Both can give you clues about whether you need to process the reads to improve the quality of data that you are putting into your analysis.

For many years this tutorial is discussed at some length for if it should be included as a main tutorial, if it should be included as an optional tutorial, or if it should be ignored all together as the quality of data increases. Recently a colleague of mine spent several days working with and trying to understand some data he got back before reaching out for help, after a few hours of running into a wall, fastqc was used to determine that the library was not constructed correctly in less than 30 minutes. Thus cementing the information as an important tutorial for a quick check which may save you significant amounts of time later on. 

Learning Objectives

This tutorial covers the commands necessary to use several common programs for evaluating read files in FASTQ format and for processing them (if necessary).

  • Introduction to the development nodes (and idev sessions) on TACC.
  • Diagnose common issues in FASTQ read files that will negatively impact analysis.
  • Trim adaptor sequences and low quality regions from the ends of reads to improve analysis.

Table of Contents

Table of Contents

Interactive development (idev) sessions

As we discussed in our first tutorial the head node is a space shared by all and we don't like stepping on each others toes. While the launcher_creator.py helper script makes working with the compute nodes much easier, they still take time to initiate a run (waiting in the que) and if you have errors in your commands your job will fail and you will lose your place in line. An idev (or interactive development session) is a way to move off the head node and onto a single compute node, but work interactively to see if your commands actually work, give you much quicker feedback, and if everything goes as you hope, your data. idev sessions are much more limited in duration and in general its not necessary to see every line a program spits out once you are familiar with the type of data you will get. Additionally, we are going to use a priority access reservation set up special for the summer school that you normally would not have access to but should guarantee immediate starting of your idev session.

Copy and paste the following command, and read through the commented lines to make sure it is function correctly:

Code Block
languagebash
titleStarting an idev session
idev  -m 180 -r CCBB_Day_1 -A UT-2015-05-18
 
# This should return the following:
#  We found an ACTIVE reservation request for you, named CCBB_Day_1.
#  Do you want to use it for your interactive session?
#  Enter y/n [default y]: 


# If for any reason you don't see the above message let me know by raising your hand.
 
# Your answer should be y, which should return the following:
#  Reservation      : --reservation=CCBB_Day_1 (ACTIVE)
 
# Some of you may see a new prompt stating something like the following:
# We need a project to charge for interactive use.
# We will be using a dummy job submission to determine your project(s).
# We will store your (selected) project $HOME/.idevrc file.
# Please select the NUMBER of the project you want to charge.\n
# 1 OTHER_PROJECTS
# 2 UT-2015-05-18
# Please type the NUMBER(default=1) and hit return:
 
# If you see this message, again let me know.
 
# You will then see something similar to the following:
# job status:  PD
# job status:  R
# --> Job is now running on masternode= nid00032...OK
# --> Sleeping for 7 seconds...OK
# --> Checking to make sure your job has initialized an env for you....OK
# --> Creating interactive terminal session (login) on master node nid00032.
 
# If this takes more than 1 minute get my attention.

...

Overview

Before you start the alignment and analysis processes, it can be useful to perform some initial quality checks on your raw data. If you don't do this (or even if you do), you may notice later that something looks fishy in the the output: for example, many of your reads are not mapping or the ends of many of your reads do not align. Both can give you clues about whether you need to process the reads to improve the quality of data that you are putting into your analysis.

For many years this tutorial is discussed at some length for if it should be included as a main tutorial, if it should be included as an optional tutorial, or if it should be ignored all together as the quality of data increases. Recently a colleague of mine spent several days working with and trying to understand some data he got back before reaching out for help, after a few hours of running into a wall, fastqc was used to determine that the library was not constructed correctly in less than 30 minutes. Thus cementing the information as an important tutorial for a quick check which may save you significant amounts of time later on. 

Learning Objectives

This tutorial covers the commands necessary to use several common programs for evaluating read files in FASTQ format and for processing them (if necessary).

  • Introduction to the development nodes (and idev sessions) on TACC.
  • Diagnose common issues in FASTQ read files that will negatively impact analysis.
  • Trim adaptor sequences and low quality regions from the ends of reads to improve analysis.

Table of Contents

Table of Contents

Interactive development (idev) sessions

As we discussed in our first tutorial the head node is a space shared by all and we don't like stepping on each others toes. While the launcher_creator.py helper script makes working with the compute nodes much easier, they still take time to initiate a run (waiting in the que) and if you have errors in your commands your job will fail and you will lose your place in line. An idev (or interactive development session) is a way to move off the head node and onto a single compute node, but work interactively to see if your commands actually work, give you much quicker feedback, and if everything goes as you hope, your data. idev sessions are much more limited in duration and in general its not necessary to see every line a program spits out once you are familiar with the type of data you will get. Additionally, we are going to use a priority access reservation set up special for the summer school that you normally would not have access to but should guarantee immediate starting of your idev session.

Copy and paste the following command, and read through the commented lines to make sure it is function correctly:

Code Block
languagebash
titleStarting an idev session
idev  -m 180 -r CCBB_Day_1 -A UT-2015-05-18
 
# This should return the following:
#  We found an ACTIVE reservation request for you, named CCBB_Day_1.
#  Do you want to use it for your interactive session?
#  Enter y/n [default y]: 


# If for any reason you don't see the above message let me know by raising your hand.
 
# Your answer should be y, which should return the following:
#  Reservation      : --reservation=CCBB_Day_1 (ACTIVE)
 
# Some of you may see a new prompt stating something like the following:
# We need a project to charge for interactive use.
# We will be using a dummy job submission to determine your project(s).
# We will store your (selected) project $HOME/.idevrc file.
# Please select the NUMBER of the project you want to charge.\n
# 1 OTHER_PROJECTS
# 2 UT-2015-05-18
# Please type the NUMBER(default=1) and hit return:
 
# If you see this message, again let me know.
 
# You will then see something similar to the following:
# job status:  PD
# job status:  R
# --> Job is now running on masternode= nid00032...OK
# --> Sleeping for 7 seconds...OK
# --> Checking to make sure your job has initialized an env for you....OK
# --> Creating interactive terminal session (login) on master node nid00032.
 
# If this takes more than 1 minute get my attention.

Your idev command line contains 3 flags: -m, -r -A. Using the `idev -h` command, can you figure out what these 3 flags mean and what you told the system you wanted to do?

Expand
titleClick here to see if you are correct...

From the OPTIONS: section of the idev help output:

-m     minutes            sets time in minutes (default: 30)

-r     reservation_name   requests use of a specific reservation

-A     account_name       sets account name (default: -A none)

So you requested an idev node for 180 minutes, using the reservation named CCBB_Day_1, and asked that it be charged to the account named UT-2015-05-18.

...

Expand
titleCan I do math on the command line?

Of course, but the bash shell has a really strange syntax for arithmetic: it uses a double-parenthesis operator. Additionally unlike a calculator that automatically prints the result to the screen when it performs an operation, we have to explicitly tell bash that we want to see what the result is. We do this using the echo command, and assigning the result to a non-named temporary variable.

Code Block
titleArithmetic in Bash
echo $((15200720 / 4))

While this is certainly possible, memorizing different formats is often not worth the effort and it can be easier to use another program (ie excel or a standard calculator to do this type of work)

While checking the number of reads a file has can solve some of the most basic problems, it doesn't really provide any direct evidence as to the quality of the sequencing data. To get this type of information before starting meaningful analysis other programs must be used.

Info
Place your sticky note on your computer when you have made it this far and start looking over the fastqc links below. Once everyone has caught up we will go over this together.

FASTQ Evaluation Tools

The first order of business after receiving sequencing data should be to check your data quality. As discussed above, this often-overlooked step helps guide the manner in which you process the data, and can prevent many headaches that could require you to redo an entire analysis after they rear their ugly heads.

FastQC

FastQC is a tool that produces a quality analysis report on FASTQ files. Online documentation for FastQC 

First and foremost, the FastQC "Summary" on the left should generally be ignored. Its "grading scale" (green - good, yellow - warning, red - failed) incorporates assumptions for a particular kind of experiment, and is not applicable to most real-world data. Instead, look through the individual reports and evaluate them according to your experiment type.

The FastQC reports I find most useful are:

  1. The Per base sequence quality report, which can help you decide if sequence trimming is needed before alignment.
  2. The Sequence Duplication Levels report, which helps you evaluate library enrichment / complexity. But note that different experiment types are expected to have vastly different duplication profiles.
  3. The Overrepresented Sequences report, which helps evaluate adapter contamination.
Expand
titleA couple of other things to note about FastQC
  • For many of its reports, FastQC analyzes only the first 200,000 sequences in order to keep processing and memory requirements down.
  • Some of FastQC's graphs have a 1-100 vertical scale that is tricky to interpret. The 100 is a relative marker for the rest of the graph. For example, sequence duplication levels are relative to the number of unique sequences,

Running FastQC

FastQC is available from the TACC module system on lonestar. Interactive GUI versions are also available for Windows and Macintosh and can be downloaded from the Babraham Bioinformatics web site. We don't want to clutter up our work space so copy the SRR030257_1.fastq file to a new directory named BDIB_fastqc_tutorial on scratch, use the module system to load fastqc, use fastqc's help option after the module is loaded to figure out how to run the program. Once the program is completed use scp to copy the important file back to your local machine (The bold words are key words that may give you a hint of what steps to take next)

Code Block
titleRunning FastQC example
collapsetrue
mkdir $SCRATCH/BDIB_fastqc_tutorial
cd $SCRATCH/BDIB_fastqc_tutorial
cp $BI/gva_course/mapping/data/SRR030257_1.fastq .
module load fastqc
 
fastqc -h  # examine program options
fastqc SRR030257_1.fastq  # run the program

Exercise: FastQC results

What did FastQC create?



-rwxr-xr-x 1 ded G-802740 498588268 May 23 12:06 SRR030257_1.fastq -rw-r--r-- 1 ded G-802740 291714 May 23 12:07 SRR030257_1_fastqc.html -rw-r--r--
Expand
titleAnswer
No Format
titlels -l shows something like this
Expand
titleAlternative using grep

grep or Global Regular Expression Print can also be used to determine the number of lines which match some criteria. Since we know the 3rd line in the fastq file is a + and a + only, we can look for a line that only has a + in it, and use that number to determine the number of sequence blocks in the file.


Code Block
languagebash
titlegrep example
grep -c "^+$" $BI/gva_course/mapping/data/SRR030257_2.fastq

the -c option tells grep to count the lines (rather than printing them all to the screen and tell you how many it found. The characters between the "" is what grep is looking for. The ^ symbol means, look for the beginning of the line, the $ symbol means look for the end of the line. Once again you see this returns 3800180 reads.




While checking the number of reads a file has can solve some of the most basic problems, it doesn't really provide any direct evidence as to the quality of the sequencing data. To get this type of information before starting meaningful analysis other programs must be used.


Info
Place your sticky note on your computer when you have made it this far and start looking over the fastqc links below. Once everyone has caught up we will go over this together.


FASTQ Evaluation Tools

The first order of business after receiving sequencing data should be to check your data quality. As discussed above, this often-overlooked step helps guide the manner in which you process the data, and can prevent many headaches that could require you to redo an entire analysis after they rear their ugly heads.

FastQC

FastQC is a tool that produces a quality analysis report on FASTQ files. Online documentation for FastQC 

First and foremost, the FastQC "Summary" on the left should generally be ignored. Its "grading scale" (green - good, yellow - warning, red - failed) incorporates assumptions for a particular kind of experiment, and is not applicable to most real-world data. Instead, look through the individual reports and evaluate them according to your experiment type.

The FastQC reports I find most useful are:

  1. The Per base sequence quality report, which can help you decide if sequence trimming is needed before alignment.
  2. The Sequence Duplication Levels report, which helps you evaluate library enrichment / complexity. But note that different experiment types are expected to have vastly different duplication profiles.
  3. The Overrepresented Sequences report, which helps evaluate adapter contamination.
Expand
titleA couple of other things to note about FastQC
  • For many of its reports, FastQC analyzes only the first 200,000 sequences in order to keep processing and memory requirements down.
  • Some of FastQC's graphs have a 1-100 vertical scale that is tricky to interpret. The 100 is a relative marker for the rest of the graph. For example, sequence duplication levels are relative to the number of unique sequences,

Running FastQC

FastQC is available from the TACC module system on lonestar. Interactive GUI versions are also available for Windows and Macintosh and can be downloaded from the Babraham Bioinformatics web site. We don't want to clutter up our work space so copy the SRR030257_1.fastq file to a new directory named GVA_fastqc_tutorial on scratch, use the module system to load fastqc, use fastqc's help option after the module is loaded to figure out how to run the program. Once the program is completed use scp to copy the important file back to your local machine (The bold words are key words that may give you a hint of what steps to take next)

Code Block
titleRunning FastQC example
collapsetrue
mkdir $SCRATCH/GVA_fastqc_tutorial
cd $SCRATCH/GVA_fastqc_tutorial
cp $BI/gva_course/mapping/data/SRR030257_1.fastq .
module load fastqc
 
fastqc -h  # examine program options
fastqc SRR030257_1.fastq  # run the program

Exercise: FastQC results

What did FastQC create?

Expand
titleAnswer
No Format
titlels -l shows something like this
-rwxr-xr-x 1 ded G-802740    455677498588268 May 23 12:0706 SRR030257_1_fastqc.zip
The SRR030257_1.fastq file is what we analyzed, so FastQC created the other two items.
fastq
-rw-r--r-- 1 ded G-802740    291714 May 23 12:07 SRR030257_1_fastqc.html
represents the results in a file viewable in a web browser. SRR030257_1_fastqc.zip is just a Zipped (compressed) version of the results.

-rw-r--r-- 1 ded G-802740    455677 May 23 12:07 SRR030257_1_fastqc.zip

The SRR030257_1.fastq file is what we analyzed, so FastQC created the other two items. SRR030257_1_fastqc.html represents the results in a file viewable in a web browser. SRR030257_1_fastqc.zip is just a Zipped (compressed) version of the results.

Looking at FastQC output

You can't run a web browser directly from your command line environment. You should copy the results back to your local machine (via scp) to open them in a web browser.

Code Block
titleTransferring fastqc data back to computer
collapsetrue
# on tacc terminal
pwd
 
# on new terminal of local computer
scp <username>@ls5.tacc.utexas.edu:<pwd_results_from_other_window>/SRR030257_1_fastqc.html ~/Desktop
 
# open the newly transferedtransferred file from from the desktop and see how the data looks

...

Expand
titleAnswer

The Per base sequence quality report does not look great, but more importantly, nearly 1.5% of all the sequences are all A's according to the Overrepresented sequences. This is something that often comes up in miseq data that has shorter insert sizes than the overall read length. Next we'll start looking at how to trim our data before continuing.

FASTQ Processing Tools

FASTX Toolkit

...

Cutadapt

Cutadapt provides a set of simple command line tools tool for manipulating fasta and fastq files. The available modules are described program description on their website . They include a fast fastx_trimmer utility for trimming fastq sequences (and quality score strings) before alignment and fastx_clipper for trimming specific sequences (such as adapters).FASTX-Toolkit is available via the TACC module systemprovides good details of all the capabilities and examples for some common tasks. Cutadapt is also available via the TACC module system allowing us to turn it on when we need to use it and not worry about it other times.

Code Block
titleFASTX_toolkit cutadapt module description
module spider fastx_toolkitcutadapt
module load fastx_toolkitcutadapt

Trimming low quality bases

Low quality base reads from the sequencer can cause an otherwise mappable sequence not to align. There are a number of open source tools that can trim off 3' bases and produce a FASTQ file of the trimmed reads to use as input to the alignment program, but  fastx_trimmer has the but  cutadapt has the advantage of being a module on TACC and therefore the easiest to use.  By default To run the program reads its input data from standard input and writes trimmed sequences to standard output, use what you know about piping and printing text to the screen to trip the fastq file to 34 bases.

...

, you simply type 'cutadapt' followed by whatever options you want, and then the name of the fastq files without any option in front of it. Use the -h option to see all the different things you can do and see if you can figure out how to trim the reads down to 34 bases.

Expand
titleHint

Type fastx_trimmer cutadapt -h to see program documentation.

Look As there is a large number of options, look below the possible solution for more detailed information of what to focus on

Code Block
titleOne possible solution
collapsetrue
cat SRR030257_1.fastq | fastx_trimmer cutadapt -l 34 >-o SRR030257_1.trimmed.fastq

...

 SRR030257_1.fastq
  • The -l 34 option says that base 34 should be the last base (i.e., trim down to 34 bases)
  • The > redirects that output to the new file on the right side -o sets the output file, in this case SRR030257_1.trimmed.fastq

Exercise: compressing the fastx_trimmer output

...

  • Listing the input file without any option in front of it (SRR030257_1.fastq) is a common way to specify input files.

Exercise: compressing the trimmed file 

Compressed files are smaller, easier to transfer, and many programs allow for their use directly. How would you tell fastx_trimmercutadapt to compress (gzip) its output file?

code
Expand
titleHint

Type fastx_trimmer cutadapt -h to see program documentation

and look for information about compressed files

cat SRR030257_1.fastq | fastx_trimmer -l 34 -z > SRR030257_1.trimmed.fastq.gz
Expand
titlePossible solution using the -z option
collapsetrue
key portion of help

Above the citation you see a paragraph that starts:

Input may also be in FASTA format. Compressed input and output is supported and auto-detected from the file name (.gz, .xz, .bz2)

So simply by adding .gz to the output file name, cutadapt will compress it after it does the trimming.

Code Block
titlePossible solution using gzip yourselfthe program directly
collapsetrue
catcutadapt -l 34 -o SRR030257_1.trimmed.fastq.gz | fastx_trimmer -l 34 | gzip >SRR030257_1.fastq
Code Block
titlePossible solution using gzip yourself
collapsetrue
gzip SRR030257_1.trimmed.fastq.gz

Both of the above solutions give the same final product, but are clearly achieved in different ways. This is done to show you that data analysis is a results driven process, if the result is correct, and you know how you got the result it is correct as long as it is reproducablereproducible.

Adapter trimming

 As mentioned above,  fastx_clipper cutadapt can be used to trim specific sequences, and based on our fastqc analysis, the sequence AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA is significantly overrepresented in our data. How would you use fastx_clippercutadapt to remove those sequences from the fastq file?

 

Expand
titleHint

Type fastx_clipper -h to see program documentationAgain, we go back to the program documentation to find what we are looking for: cutadapt -h

Look below the possible solution for more detailed information on what to focus on if you cant find what you are looking for .

Code Block
titlePossible solution
collapsetrue
fastx_clippercutadapt -i SRR030257_1.trimmed.fastq -o SRR030257_1.trimmed.depleted.fastq -a AAAAAAAAAAAAAAAAAAAA -l 34 -n m 16 SRR030257_1.fastq

 

Command portionpurpose
-i SRR030257_1.trimmed.fastquse this file as input-o SRR030257_1.trimmed.depleted.fastqcreate this new output file

-a AAAAAAAAAAAAAAAAA

remove bases containing this sequence
-l 34trim reads to 34 bases
-m 16discard any read shorter than 34 16 bases after sequence removed
-nkeep reads containing "N" bases in them. Consider how they are treated in downstream applications

Other fastx toolkit programs

What other fastx and fastq manipulation programs are part of the fastx toolkit? The available modules are described on their website, but we can also learn some things from the command prompt using module spider fastx_toolkit.

Expand
titleHint

Type fast then tab twice to see their names
See all the programs like this:

Code Block
titlefastx toolkit programs
ls $TACC_FASTX_BIN

...

as these are more likely difficult to uniquely align to the genome
SRR030257_1.fastquse this file as input

From the summary printed to the screen you can see that this removed a little over an additional 2.2M bp of sequence.

A note on versions 

In our first tutorial we mentioned how knowing what version of a program you are using can be. When we loaded the the cutadapt module we didn't specify what version to load. Can you figure out what version you used, and what the most recent version of the program there is? .

Expand
titleHow to figure out the currently installed version

try using the module system or the program's help files

Code Block
languagebash
titleStill not sure?
collapsetrue
module spider cutadapt

cutadapt --version

Figuring out the most recent version is a little more complicated. Unlike programs on your computer like Microsoft Office or your internet browser, there is nothing in an installed program that tells you if you have the newest version or even what the newest version is. If you go to the programs website (easily found with google or this link), the changes section lists all the versions that have been list with v2.3 being released on April 25th this year.

Expand
titleTake a moment to think about why there might be such a big discrepancy before clicking here for the list of possible reasons I put together.

The biggest reason is that someone at tacc has to go through a process of noticing that there is a new version, figuring out if all of the changes are compatible with tacc, installing it, and then fielding questions and problems from users who were used to using the old version and have problems with the new version somehow.

The next reason is that the existing version works, and if you read through some of the recent changes, are very small and do not effect the function of the program very much.


Together, this is why I encourage you to make note of what version of the programs you use when you use them (primarily by loading modules complete with the versions in your .bashrc file), and to consider installing programs yourself when appropriate (as is discussed in the advanced trimmomatic tutorial for read trimming).


Optional Exercise: Improve the quality of R2 the same way you did for R1.

Unfortunately we don't have time during the class to do this, but as a potential exercise in your free time, you could improve R2 the same way you did R1 and use the improved fastq files in the subsequent read mapping and variant calling tutorials to see the difference it can make.



Return to GVA2017 GVA2019 course page