FASTQ sequence dataRNA-Seq is a revolutionary approach for discovering and investigating the transcriptome using next-generation sequencing technologies(Wang et al. 2009). Typically, this transcriptome analysis aims to identify genes differentially expressed across different conditions or tissues, resulting in an understanding of the important pathways that are associated with the conditions(Wang et al. 2009).
RNASeqR is an user-friendly R-based tool for running an RNA-Seq analysis pipeline including quality assessment, read alignment and quantification, differential expression analysis, and functional analysis. The main features of this package are an automated workflow, comprehensive reports with data visualization, and an extendable file structure. In this package, the new tuxedo pipeline published in Nature Protocols in 2016 can be fully implemented in the R environment, including extra functions such as reads quality assessment and functional analysis.
The following are the main tools that are used in this package: ‘HISAT2’ for read alignment(Kim et al. 2015); ‘StringTie’ for alignment assembly and transcripts quantification(Pertea et al. 2015); ‘Rsamtools’ for converting SAM files to BAM files(Morgan et al. 2018); ‘Gffcompare’ for comparing merged GTF files with reference GTF files; ‘systemPipeR’ for quality assessment(Backman et al. 2016); ‘ballgown’ (Fu et al. 2018), ‘DESeq2’ (Love et al. 2014) and ‘edgeR’ (Robinson et al. 2010;McCarthy et al. 2012) for finding potential differentially expressed genes; and ‘clusterProfiler’ (Yu et al. 2012) for Gene Ontology(GO) functional analysis and Kyoto Encyclopedia of Genes and Genomes(KEGG) pathway analysis.
The central concept behind this package is that each step involved in RNA-Seq data analysis is a function call in R. At the beginning, users will create a RNASeqRParam S4 object by running the RNASeqRParam() constructor function for all variable checking. After the creation of RNASeqRParam, it will be used as input to the following analysis functions.
RNASeqEnvironmentSet_CMD() or RNASeqEnvironmentSet(): to setup the RNA-Seq environment.
RNASeqQualityAssessment_CMD() or RNASeqQualityAssessment(): (optional) to run a quality assessment step.
RNASeqReadProcess_CMD() or RNASeqReadProcess(): to run reads alignment and quantification.
RNASeqDifferentialAnalysis_CMD() or RNASeqDifferentialAnalysis(): to run differential analysis via different R packages.
RNASeqGoKegg_CMD() or RNASeqGoKegg(): to conduct GO and KEGG analysis.
Functions with the CMD suffix create an R script and run nohup R CMD BATCH script.R in the background. Functions with no CMD suffix process in the R shell. After running the above functions, the whole RNA-Seq analysis is done and the files generated in each step are stored in an organized file directory. The RNASeqR package makes two-group comparative RNA-Seq analysis more efficient and easier for users.
Functions with CMD suffix will create an R script and run nohup R CMD BATCH script.R in background while functions with no CMD suffix will be processed in R shell. Files generated in each step will be kept in proper directory. Once the workflow is completed, a comprehensive RNA-Seq analysis is done. Additionally, this package is mainly designed for a two-group comparison setting, i.e. differential expression profile between two conditions.
Sample data used in this vignette can be downloaded from the RNASeqRData experiment package. It originated from NCBI’s Sequence Read Archive for the entries SRR3396381, SRR3396382, SRR3396384, SRR3396385, SRR3396386, and SRR3396387. These samples are from Saccharomyces cerevisiae. Suitable reference genome and gene annotation files for this species can be further downloaded from iGenomes, Ensembl, R64-1-1. To create a mini dataset for demonstration purposes, reads aligned to the region from 0 to 100000 on chromosome XV were extracted. The analysis of this mini dataset will be shown in this vignette. The experimental data package is located here.
For more real case-control data and RNA-Seq analysis results from this package, please go to this website: https://github.com/HowardChao/RNASeqR_analysis_result.
Necessary:
R version >= 3.5.0
Operating System: Linux and macOS are supported in the RNASeqR package. Windows is not supported. (because StringTie and HISAT2 are not available for Windows).
Third-party software used in this package includes HISAT2, StringTie and Gffcompare. The availability of these commands will be checked by system2() through the R shell at the end of the ‘Environment Setup’ step. The environment must successfully built before running the following RNA-Seq analysis. By default, binaries will be installed based on the operating system of the workstation; therefore there is no additional compiling required. Alternatively, users can still decide to skip certain software binary installation. For more details, please refer to the ‘Environment Setup’ chapter.
Recommended:
Python: Python2 or Python3.
2to3: If the Python version on the workstation is 3, this command will be used. Generally, 2to3 is available if Python3 is available.
Python and 2to3 are used for creating raw read counts for DESeq2 and edgeR.
2to3 command available.If one of these conditions is met, the raw read count will be created and DESeq2 and edgeR will be run automatically in the ‘Gene-level Differential Analyses’ step. If not, DESeq2 and edgeR will be skipped during ‘Gene-level Differential Analysis’ step. Checking the Python version and 2to3 command on the workstation beforehand is highly recommended but not necessary.
HISAT2 indexex: Users are advised to provide an ‘indices/’ directory in ‘inputfiles/’. HISAT2 requires at least 160 GB of RAM and several hours to index the entire human genome.
if (!require("BiocManager")) {
install.packages("BiocManager")
}
BiocManager::install("RNASeqRData")
This is the first step of the RNA-Seq analysis workflow in this package. Prior to conducting RNA-Seq analysis, it is necessary to implement a constructor function, called RNASeqRParam() and to create a RNASeqRParam S4 object which stores parameters not only for pre-checking but also for utilizing as input the parameters in the subsequent steps.
RNASeqRParam Slots ExplanationThere are 11 slots in RNASeqRParam:
os.type : The operating system type. Value is linux or osx. This package only supports ‘Linux’ and ‘macOS’ (not ‘Windows’). If another operating system is detected, ERROR will be reported.
python.variable : A Python-related variable. The value is a list of whether Python is available and the Python version (TRUE or FALSE, 2 or 3).
python.2to3 : Availability of the 2to3 command. THe value is TRUE or FALSE.
path.prefix : Path prefix of the ‘gene_data/’, ‘RNASeq_bin/’, ‘RNASeq_results/’, ‘Rscript/’ and ‘Rscript_out/’ directories. It is recommended that you create a new, empty directory in which all the subsequent RNA-Seq results can be saved.
input.path.prefix : Path prefix of the ‘input_files/’ directory. Users should prepare an ‘input_file/’ directory with the following rules:
genome.name.fa: Reference genome in FASTA file formation.
genome.name.gtf: Gene annotation in GTF file formation.
raw_fastq.gz/: Directory storing FASTQ files.
Supports paired-end read files only.
Names of paired-end FASTQ files : ’sample.pattern_1.fastq.gz’ and ’sample.pattern_2.fastq.gz’. sample.pattern must be distinct for each sample.
phenodata.csv: Information about the RNA-Seq experiment design.
First column : Distinct ids for each sample. The value of each sample of this column must match sample.pattern in FASTQ files in ‘raw_fastq.gz/’. Column names must be ids.
Second column : An independent variable for the RNA-Seq experiment. Values of each sample of this column can only be parameter case.group or control.group. The column name is the parameter independent.variable.
indices/ : The directory storing HT2 index files for the HISAT2 alignment tool.
This directory is optional. HT2 index files corresponding to the reference genome can be installed at HISAT2 official website. Providing HT2 files can accelerate the subsequent analysis steps. It is highly advised that you install HT2 files.
If HT2 index files are not provided, the ‘input_files/indices/’ directory should be deleted.
genome.name : The genome name defined in this RNA-Seq workflow (ex. ‘genome.name.fa’, ‘genome.name.gtf’)
sample.pattern : A regular expression of paired-end fastq.gz files under ‘input_files/raw_fastq.gz/’. IMPORTANT!! The expression shouldn’t have _[1,2].fastq.gz at the end.
independent.variable: Independent variable for the biological experiment design of a two-group RNA-Seq analysis workflow.
case.group : Name of the case group.
control.group : Name of the control group.
indices.optional : A logical value indicating whether ‘input_files/indices/’ exists. Value is TRUE or FALSE
RNASeqRParam Constructor CheckingCreate a new directory for the RNA-Seq analysis. It is highly recommended to create a new, completely empty directory. The parameter path.prefix of RNASeqRParam() constructor should be the absolute path of this new directory. All the RNA-SeqR-related files are generated in the subsequent steps will be stored inside of this directory.
Create a valid ‘input_files/’ directory. You should create a file directory named ‘input_files/’ with the neccessary files inside. It should follow the rules mentioned above.
RNASeqRParam S4 object. This constructor will check the validity of the input parameters before creating the S4 objects.
Operating system
Python version
2to3 command
Structure, content, and rules of ‘inputfiles/’
Validity of input parameters
library(RNASeqR)
library(RNASeqRData)
input_files.path <- system.file("extdata/", package = "RNASeqRData")
rnaseq_result.path <- tempdir(check = TRUE)
list.files(input_files.path, recursive = TRUE)
## [1] "input_files/Saccharomyces_cerevisiae_XV_Ensembl.fa"
## [2] "input_files/Saccharomyces_cerevisiae_XV_Ensembl.gtf"
## [3] "input_files/phenodata.csv"
## [4] "input_files/raw_fastq.gz/SRR3396381_XV_1.fastq.gz"
## [5] "input_files/raw_fastq.gz/SRR3396381_XV_2.fastq.gz"
## [6] "input_files/raw_fastq.gz/SRR3396382_XV_1.fastq.gz"
## [7] "input_files/raw_fastq.gz/SRR3396382_XV_2.fastq.gz"
## [8] "input_files/raw_fastq.gz/SRR3396384_XV_1.fastq.gz"
## [9] "input_files/raw_fastq.gz/SRR3396384_XV_2.fastq.gz"
## [10] "input_files/raw_fastq.gz/SRR3396385_XV_1.fastq.gz"
## [11] "input_files/raw_fastq.gz/SRR3396385_XV_2.fastq.gz"
## [12] "input_files/raw_fastq.gz/SRR3396386_XV_1.fastq.gz"
## [13] "input_files/raw_fastq.gz/SRR3396386_XV_2.fastq.gz"
## [14] "input_files/raw_fastq.gz/SRR3396387_XV_1.fastq.gz"
## [15] "input_files/raw_fastq.gz/SRR3396387_XV_2.fastq.gz"
Check the files in ‘inputfiles/’ directory.
exp <- RNASeqRParam(path.prefix = rnaseq_result.path,
input.path.prefix = input_files.path,
genome.name = "Saccharomyces_cerevisiae_XV_Ensembl",
sample.pattern = "SRR[0-9]*_XV",
independent.variable = "state",
case.group = "60mins_ID20_amphotericin_B",
control.group = "60mins_ID20_control")
show(exp)
## RNASeqRParam S4 object
## os.type : linux
## python.variable : (Availability: TRUE , Version: 2 )
## python.2to3 : TRUE
## path.prefix : /tmp/RtmpP3pjxj/
## input.path.prefix : /home/biocbuild/bbs-3.8-bioc/R/library/RNASeqRData/extdata/
## genome.name : Saccharomyces_cerevisiae_XV_Ensembl
## sample.pattern : SRR[0-9]*_XV
## independent.variable : state
## case.group : 60mins_ID20_amphotericin_B
## control.group : 60mins_ID20_control
## indices.optional : FALSE
## independent.variable : state
In this example, the RNASeqRParam S4 object is stored in exp for subsequent RNA-Seq analysis steps. Any ERROR occurring in the checking steps will terminate the program.
This is the second step of the RNA-Seq analysis workflow in this package. To set up the environment, run RNASeqEnvironmentSet_CMD() to execute the process in the background, or run RNASeqEnvironmentSet() to execute the process in the R shell.
path.prefix directory. Here is the usage of these five main directories:
‘gene_data/’: Symbolic links of ‘input_files/’ and files that are created in each step of RNA-Seq analysis will be stored in this directory.
‘RNASeq_bin/’: The binaries of necessary tools, HISAT2, SAMtools, StringTie and Gffcompare, are installed in this directory.
‘RNASeq_results’: The RNA-Seq results, for example, alignment results, quality assessment results, differential analysis results etc., will be stored in this directory.
‘Rscript’: If your run the XXX_CMD() function, the corresponding R script(XXX.R) for certain steps will be created in this directory.
‘Rscript_out’: The corresponding output report for R scripts (XXX.Rout) will be stored in this directory.
path.prefix directory.The operating system of your workstation will be detected. If the operating system is not Linux or macOS, ERROR will be reported. Users can decide whether the installation of essential programs(HISAT2, StringTie and Gffcompare) is going be automatically processed.
Third-party softwares used in this package includes HISAT2, StringTie and Gffcompare. Binaries are available for these three programs, and by default, they will be installed automatically based on the operating system of the workstation. Zipped binaries will be unpacked and exported to the R environment PATH. No compilation is needed.
To specify, there are three parameters(install.hisat2, install.stringtie and install.gffcompare) in both the RNASeqEnvironmentSet_CMD() and RNASeqEnvironmentSet() functions for users to determine which software is going to be installed automatically or skipped. The default settings of these parameters are TRUE so that these three programs will be installed directly. Otherwise, users can skip certain software installation processes by turning the values to FALSE. Please make sure to check that the skipped programs are available using system2() through the R shell. Unavailability of any of the programs will cause failure in the ‘Environment Setup’ step.
Here is the version information of each software binary.
hisat2-2.1.0-Linux_x86_64.zip or hisat2-2.1.0-OSX_x86_64.zip zipped file will be installed.stringtie-1.3.4d.Linux_x86_64.tar.gz or stringtie-1.3.4d.Linux_x86_64 will be installed.gffcompare-0.10.4.Linux_x86_64.tar.gz or gffcompare-0.10.4.Linux_x86_64.tar.gz will be installed.‘RNASeq_bin/’ will be added to the R environment PATH so that these binaries can be found in the R environment in the R shell through system2(). In the last step of environment setup, the hisat2 --version,stringtie --version,gffcompare --version, and samtools --version commands will be checked in order to make sure the environment is correctly constructed. The environment must be set up successfully before the subsequent analyses.
Run RNASeqEnvironmentSet_CMD() or RNASeqEnvironmentSet().
RNASeqEnvironmentSet_CMD(exp)
RNASeqEnvironmentSet(exp)
FASTQ sequence dataThis is the third step of the RNA-Seq analysis workflow in this package. Different from other necessary steps, it is optional and can be run several times with each result stored separately. Although this step can be skipped, it is strongly recommended that it be performed before processing the alignment step. To evaluate the quality of the raw reads in the FASTQ files, run RNASeqQualityAssessment_CMD() in the background or run RNASeqQualityAssessment() to execute the process in the R shell.
In this step, the systemPipeR package is used for evaluating sequencing reads and the details are as follows:
Check the number of times that the user has run the quality assessment process and create the corresponding files ‘RNASeq_results/QA_results/QA_{times}’.
RNA-Seq environment set up. The ‘rnaseq/’ directory will be created by systemPipeR package.
Create the ‘data.list.txt’ file.
Reading FASTQ files and create ‘fastqReport.pdf’ containing the results of the quality assessment.
Remove the ‘rnaseq/’ directory.
This quality assessment result (example below) is generated by systemPipeR package. It will be stored as a PDF.
Run RNASeqQualityAssessment_CMD() or RNASeqQualityAssessment().
RNASeqQualityAssessment_CMD(exp)
RNASeqQualityAssessment(exp)
## [1] "Generated rnaseq directory. Next run in rnaseq directory, the R code from *.Rmd (*.Rnw) template interactively. Alternatively, workflows can be exectued with a single command as instructed in the vignette."
This is the fourth step of the RNA-Seq analysis workflow in this package. To process raw reads in FASTQ files, users can either run RNASeqRawReadProcess_CMD() to execute the process in background or run RNASeqRawReadProcess() to execute the process in the R shell. For further details about the commands and parameters that executed during each step, please check the reported ‘RNASeq_results/COMMAND.txt’.
In a preparation step (the RNASeqRParam creation step), the ‘indices/’ directory is checked for whether HT2 index files already exist. If not, the following commands will be executed:
Input: ‘genome.name.gtf’, ‘genome.name.fa’
Output: ‘genome.name.ss’, ‘genome.name.exon’, ’genome.name_tran.{number}.ht2’
extract_splice_sites.py, extract_exons.py execution
hisat2-build index creation
genome.name.ss and genome.name.exon created in the previous step. Be aware that the index building step requires a larger amount of memory and longer time than other steps, and it might not be possible to run on some personal workstations. It is highly recommended that you check the availability of HT2 index files at the HISAT2 official website for your target reference genome beforehands. Pre-installing HT2 index files will greatly shorten the analysis time.Input: ’genome.name_tran.{number}.ht2’, ‘sample.pattern.fastq.gz’
Output: ‘sample.pattern.sam’
hisat2 command is executed on paired end FASTQ files. SAM files will be created.
SAM files are stored in ‘gene_data/raw_bam/’.CSV) and picture (PNG) format is created and kept in the directory ‘RNASeq_results/Alignment_Report’.SAM to BAM ConverterIn this step, users can choose whether they want to use ‘Rsamtools’(an R package) or ‘SAMtools’ ( a command-line-based tool) to do files conversion by setting the SAMtools.or.Rsamtools parameter to Rsamtools or SAMtools. By default, Rsamtools will be used. However, if the amount of RNA-Seq data is too large, ‘Rsamtools’ might not be able to finish this process due to the Rtmp file issue, and therefore ‘SAMtools’ is recommended. Users have to make sure the ‘samtools’ command is available on the workstation beforehands or ERROR will be reported.
Input: ‘sample.pattern.sam’
Output: ‘sample.pattern.bam’
samtools in the R environment. In this step, SAM files from HISAT2 will be converted to BAM files by running the asBam() function.
BAM files are stored in ‘gene_data/raw_sam/’.Input: ‘genome.name.gtf’, ‘sample.pattern.bam’
Output: ‘sample.pattern.gtf’
stringtie command is executed.
GTF files which are from each FASTQ files are stored in ‘gene_data/raw_gtf/’GTF MergerInput: ‘sample.pattern.gtf’
Output: ‘stringtiemerged.gtf’, ‘mergelist.txt’
stringtie command is executed.
sample.pattern.gtf into stringtiemerged.gtfInput: ‘genome.name.gtf’, ‘stringtie_merged.gtf’
Output: ‘merged.annotated.gtf’, ‘merged.loci’, ‘merged.stats’, ‘merged.stringtie_merged.gtf.refmap’, ‘merged.stringtie_merged.gtf.tmap’, ‘merged.tracking’
gffcompare command is executed.
GTF file and reference annotation files is reported in the ‘merged/’ directory.Input: ‘stringtie_merged.gtf’
Output: ‘ballgown/’, ‘gene_abundance/’
stringtie command is executed.
TSV file under each sample name in ‘gene_data/gene_abundance/’.Whether this step is executed depends on the availability of Python on your workstation.
Input: ‘samplelst.txt’
Output: ‘gene_count_matrix.csv’, ‘transcript_count_matrix.csv’
The reads count table converter Python script is downloaded as prepDE.py
When Python is not available, this step is skipped.
When Python2 is available, prepDE.py is executed.
When Python3 is available, the 2to3 command will be checked.(Usually, if Python3 is installed, 2to3 command will be installed too.)
When Python3 is available but the 2to3 command is unavailable, the raw read count step will be skipped.
When Python3 and the 2to3 command are available, prepDE.py is converted to a file that can be executed by Python2 and is automatically executed.
Run RNASeqReadProcess_CMD() or RNASeqReadProcess().
RNASeqReadProcess_CMD(exp)
RNASeqReadProcess(exp)
This is the fifth step of the RNA-Seq analysis workflow in this package. To identify differentially expressed genes, users can either run RNASeqDifferentialAnalysis_CMD() to execute the process in the background or run RNASeqDifferentialAnalysis() to execute the process in the R shell. In this package, we provide three normalized expression values: fragments per kilobase per million reads (FPKM) (Mortazavi et al. 2008), normalized counts by means of median of ratios normalization (MRN), or trimmed mean of m-values (TMM), each with proper statistical analyses using the R packages, ballgown, DESeq2, and edgeR. Gene IDs from StringTie and the ballgown R package will be mapped to ‘gene_name’ in the GTF file for further functional analysis.
Here we illustrate general data visualization before and after differential expression analysis. The results based on each differential analysis tool(ballgown, DESeq2, edgeR) are kept in the directory ‘RNASeq_results/’. The plots shown below are the statistical results visualization of example data in the RNASeqRData package based on MRN-normalized expression values from DESeq2.
For real data analysis results, please go to this website: https://howardchao.github.io/RNASeqR_analysis_result/.
When visualizing the frequency of expression value per sample using the ggplot2 R package, the x-axis represents the range of normalized counts value by MRN or log2(MRN+1) value and the y-axis represents the frequency of each value on the x-axis
‘Frequency_Plot_normalized_count_ggplot2.png’
‘Frequency_Plot_log_normalized_count_ggplot2.png’
You can display the distribution of normalized expression values (e.g., log2(MRN+1) values) in a boxplot and a violin plot using the ggplot2 R package. Samples are colored as follows: blue for the case group and yellow for the control group.
‘Box_Plot_ggplot2.png’
‘Violin_Plot_ggplot2.png’
To display how the biological samples compare in overall similarities and differences using principal component analysis(PCA); the principal component scores of the top five dimensions are calculated using the FactoMineR package and the results are extracted and visualized using factoextra or ggplot2.
‘Dimension_PCA_Plot_factoextra.png’
‘PCA_Plot_factoextra.png’: Samples are colored as follows: blue for the case group and yellow for the control group. The small point represents each sample while the big one represents each comparison group. Ellipases can be further added for grouping samples.
‘PCA_Plot_ggplot2.png’: Samples are colored as described above.
You can display Pearson correlation coefficient of a pairwise correlation analysis of changes in gene expression from all samples calculated by stats using ggplot2(correlation heat plot), corrplot(correlation dot plot), and PerformanceAnalytics(correlation bar plot). The colors from red to blue indicate the value of the correlation, from maximum value to minimum value, among all samples.
‘Correlation_Heat_Plot_ggplot2.png’
‘Correlation_Dot_Plot_corrplot.png’
‘Correlation_Bar_Plot_PerformanceAnalytics.png’
To display how the biological samples compare in similarities and differences based on the expression value of DEGs using PCA. FactoMineR, factoextra and ggplot2 packages are used in this step.
‘Dimension_PCA_Plot_factoextra.png’
‘PCA_Plot_factoextra.png’: Samples are colored as follows: blue for the case group and yellow for the control group. The small point represents each sample while the big one represents each comparison group. Ellipases can be further added for grouping samples.
‘PCA_Plot_ggplot2.png’: Samples are colored as described above.
Ballgown is an R package designed for differential expression analysis of RNA-Seq data. This package extracts FPKM values, i.e., read counts normalized by both library size and gene length, from StringTie software followed by applying a parametric F-test comparing the nested linear model as its default statistic model to identify DEGs. The basic steps are as follows:
Create a ballgown object that will be stored in ‘RNASeq_results/ballgown_analysis/ballgown.rda’.
Filter out the genes for which the sum of FPKM values of all samples per gene equals 0.
Calculate log2-based fold change value in column log2FC.
Split a matrix of normalized counts into case and control groups based on phenotype data (‘gene_data/phenodata.csv’) and assign relative information in column sample.pattern.FPKM.
Generate a csv file, ‘RNASeq_results/ballgown_analysis/ballgown_normalized_result.csv’, in which to store normalized FPKM values, mean expression values per group, and statistical results.
Select DEGs based on default criteria: pval < 0.05 and log2FC > 1 | log2FC < 1. Store the result in ‘RNASeq_results/ballgown_analysis/ballgown_normalized_DE_result.csv’
Additional data visualization: aside from the general data visualization mentioned above, transcript-related plots and an MA plot are also provided.
‘Distribution_Transcript_Count_per_Gene_Plot.png’: This plots the distribution of transcript counts per gene.