Ballgown is a software package designed to facilitate flexible differential expression analysis of RNA-seq data.
Before using the Ballgown R package, a few preprocessing steps are necessary:
The Ballgown package provides functions to organize, visualize, and analyze the expression measurements for your transcriptome assembly.
Start R and run:
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("ballgown")
Users need to run Tablemaker to organize assembly output into a format that Ballgown can load. Tablemaker can be downloaded from figshare:
Tablemaker can also be built from source from this repository by following Cufflinks' instructions.
Tablemaker needs to be run on each RNA-seq sample in your experiment. It requires one transcripome assembly, in GTF format, and read alignments for each sample, in BAM format. From the command line, Tablemaker is run as follows:
tablemaker -p 4 -q -W -G merged.gtf -o sample01_output read_alignments.bam
where:
-p denotes how many threads to use (the program can take a few hours to run, but can be parallelized)-q can be removed for more verbose output messages-W and -G merged.gtf are required. The -W tells the program to run in tablemaker mode (rather than Cufflinks mode), and the -G argument points to the assembly GTF file, which gives the assembled transcripts' structures. For Cufflinks users, often this is the merged.gtf output from Cuffmerge.-o is the desired output directory for the sample (each sample should have its own output directory)accepted_hits.bamThe output is 5 files, written to the specified output directory:
e_data.ctab: exon-level expression measurements. One row per exon. Columns are e_id (numeric exon id), chr, strand, start, end (genomic location of the exon), and the following expression measurements for each sample:
rcount: reads overlapping the exon ucount: uniquely mapped reads overlapping the exon mrcount: multi-map-corrected number of reads overlapping the exoncov average per-base read coverage cov_sd: standard deviation of per-base read coveragemcov: multi-map-corrected average per-base read coveragemcov_sd: standard deviation of multi-map-corrected per-base coveragei_data.ctab: intron- (i.e., junction-) level expression measurements. One row per intron. Columns are i_id (numeric intron id), chr, strand, start, end (genomic location of the intron), and the following expression measurements for each sample:
rcount: number of reads supporting the intronucount: number of uniquely mapped reads supporting the intronmrcount: multi-map-corrected number of reads supporting the intront_data.ctab: transcript-level expression measurements. One row per transcript. Columns are:
t_id: numeric transcript idchr, strand, start, end: genomic location of the transcriptt_name: Cufflinks-generated transcript idnum_exons: number of exons comprising the transcriptlength: transcript length, including both exons and intronsgene_id: gene the transcript belongs togene_name: HUGO gene name for the transcript, if knowncov: per-base coverage for the transcript (available for each sample)FPKM: Cufflinks-estimated FPKM for the transcript (available for each sample)e2t.ctab: table with two columns, e_id and t_id, denoting which exons belong to which transcripts. These ids match the ids in the e_data and t_data tables.i2t.ctab: table with two columns, i_id and t_id, denoting which introns belong to which transcripts. These ids match the ids in the i_data and t_data tables.At this point, Tablemaker should have been run on all samples in the experiment. For this example, assume each sample's Tablemaker output directory is a subfolder of the same root directory. The Ballgown package's extdata folder provides an example of such a directory, where the folder structure looks like:
extdata/
sample01/
e2t.ctab
e_data.ctab
i2t.ctab
i_data.ctab
t_data.ctab
sample02/
e2t.ctab
e_data.ctab
i2t.ctab
i_data.ctab
t_data.ctab
...
sample20/
e2t.ctab
e_data.ctab
i2t.ctab
i_data.ctab
t_data.ctab
Data is loaded using the ballgown function.
If your data is stored in directories matching the above structure (one root folder, subfolders named by sample, and .ctab files in the subfolders), you can use the dataDir and samplePattern arguments to load the data. samplePattern takes a regular expressions specifying the subfolders that should be included in the ballgown object:
library(ballgown)
data_directory = system.file('extdata', package='ballgown') # automatically finds ballgown's installation directory
# examine data_directory:
data_directory
## [1] "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata"
# make the ballgown object:
bg = ballgown(dataDir=data_directory, samplePattern='sample', meas='all')
bg
## ballgown instance with 100 transcripts and 20 samples
If your data is stored in a directory structure other than the one specified above, you can use the samples argument in the ballgown function: samples should be a vector (1-d array) with one entry per sample, where the entry gives the path to the folder containing that sample's .ctab files.
The result from either of these approaches is an object of class ballgown (named bg in these examples).
In the rest of this document, we use bg to refer to the first example, where samples are named sample01 through sample20.
A note for large experiments (with many samples or with large genomes): loading the data might require a lot of time and memory. In these cases, it's often useful to do the data loading in non-interactive mode. More specifically, you could create a script called load.R that contains these lines:
library(ballgown)
data_directory = system.file('extdata', package='ballgown')
bg = ballgown(dataDir=data_directory, samplePattern='sample', meas='all')
save(bg, file='bg.rda')
You could then run this script non-interactively using R CMD BATCH: from the command line, run:
R CMD BATCH load.R
This may take some time, but when it finishes, the file bg.rda will be saved in the current directory, and you can read it back into R using the load() function. Rda files are usually only a few Gb on disk, even for large experiments. It is also possible to load only a subset of all the expression measurements by changing the meas argument to the ballgown function. For example, to only load transcript-level FPKMs, set meas = 'FPKM' and to load average coverage values and read counts, set meas=c('cov', 'rcount').
See ?ballgown for detailed information on creating Ballgown objects.
A ballgown object has six slots: structure, expr, indexes, dirs, mergedDate, and meas.
The structure slot depends heavily on the GenomicRanges Bioconductor package (Lawrence et al. (2013)). The slot specifies the structure, i.e., genomic locations and relationships between exons, introns, and transcripts, of the transcriptome assembly. It is convenient to represent exons and introns as intervals and to represent transcripts as a set of intervals (exons), so assembled exons and introns are available as GRanges objects, and the assembled transcripts are available as a GRangesList object. This means that useful range operations, such as findOverlaps and reduce, are readily available for assembled features.
Exon, intron, and transcript structures are easily extracted from the main ballgown object:
structure(bg)$exon
## GRanges object with 633 ranges and 2 metadata columns:
## seqnames ranges strand | id transcripts
## <Rle> <IRanges> <Rle> | <integer> <character>
## [1] 18 24412069-24412331 * | 12 10
## [2] 22 17308271-17308950 + | 55 25
## [3] 22 17309432-17310226 + | 56 25
## [4] 22 18121428-18121652 + | 88 35
## [5] 22 18138428-18138598 + | 89 35
## ... ... ... ... . ... ...
## [629] 22 51221929-51222113 - | 3777 1294
## [630] 22 51221319-51221473 - | 3782 1297
## [631] 22 51221929-51222162 - | 3783 1297
## [632] 22 51221929-51222168 - | 3784 1301
## [633] 6 31248149-31248334 * | 3794 1312
## -------
## seqinfo: 3 sequences from an unspecified genome; no seqlengths
structure(bg)$intron
## GRanges object with 536 ranges and 2 metadata columns:
## seqnames ranges strand | id transcripts
## <Rle> <IRanges> <Rle> | <integer> <character>
## [1] 22 17308951-17309431 + | 33 25
## [2] 22 18121653-18138427 + | 57 35
## [3] 22 18138599-18185008 + | 58 35
## [4] 22 18185153-18209442 + | 59 35
## [5] 22 18385514-18387397 - | 72 41
## ... ... ... ... . ... ...
## [532] 22 51216410-51220615 - | 2750 c(1294, 1297, 1301)
## [533] 22 51220776-51221928 - | 2756 1294
## [534] 22 51220780-51221318 - | 2757 1297
## [535] 22 51221474-51221928 - | 2758 1297
## [536] 22 51220780-51221928 - | 2759 1301
## -------
## seqinfo: 1 sequence from an unspecified genome; no seqlengths
structure(bg)$trans
## GRangesList object of length 100:
## $`10`
## GRanges object with 1 range and 2 metadata columns:
## seqnames ranges strand | id transcripts
## <Rle> <IRanges> <Rle> | <integer> <character>
## [1] 18 24412069-24412331 * | 12 10
## -------
## seqinfo: 3 sequences from an unspecified genome; no seqlengths
##
## $`25`
## GRanges object with 2 ranges and 2 metadata columns:
## seqnames ranges strand | id transcripts
## <Rle> <IRanges> <Rle> | <integer> <character>
## [1] 22 17308271-17308950 + | 55 25
## [2] 22 17309432-17310226 + | 56 25
## -------
## seqinfo: 3 sequences from an unspecified genome; no seqlengths
##
## $`35`
## GRanges object with 4 ranges and 2 metadata columns:
## seqnames ranges strand | id transcripts
## <Rle> <IRanges> <Rle> | <integer> <character>
## [1] 22 18121428-18121652 + | 88 35
## [2] 22 18138428-18138598 + | 89 35
## [3] 22 18185009-18185152 + | 90 35
## [4] 22 18209443-18212080 + | 91 35
## -------
## seqinfo: 3 sequences from an unspecified genome; no seqlengths
##
## ...
## <97 more elements>
The expr slot is a list that contains tables of expression data for the genomic features. These tables are very similar to the *_data.ctab Tablemaker output files. Ballgown implements the following syntax to access components of the expr slot:
*expr(ballgown_object_name, <EXPRESSION_MEASUREMENT>)
where * is either e for exon, i for intron, t for transcript, or g for gene, and .ctab file. Gene-level measurements are calculated by aggregating the transcript-level measurements for that gene. All of the following are valid ways to extract expression data from the bg ballgown object:
transcript_fpkm = texpr(bg, 'FPKM')
transcript_cov = texpr(bg, 'cov')
whole_tx_table = texpr(bg, 'all')
exon_mcov = eexpr(bg, 'mcov')
junction_rcount = iexpr(bg)
whole_intron_table = iexpr(bg, 'all')
gene_expression = gexpr(bg)
Calculating the gene-level expression measurements can be slow for large experiments.
The *expr functions return matrices unless meas = 'all', in which case some additional feature metadata is returned and the result is a data.frame.
The indexes slot of a ballgown object connects the pieces of the assembly and provides other experimental information. indexes(bg) is a list with several components that can be extracted with the $ operator.
Perhaps most importantly, there is a component called pData that should hold a data frame of phenotype information for the samples in the experiment. This must be created manually. It is very important that the rows of pData are in the correct order. Each row corresponds to a sample, and the rows of pData should be ordered teh same as the tables in the expr slot. You can check that order by running sampleNames(bg). The pData component can be added during construction (you can pass a data frame to the ballgown function), or you can add it later:
pData(bg) = data.frame(id=sampleNames(bg), group=rep(c(1,0), each=10))
The other components of indexes are the e2t and i2t tables described in the Tablemaker section, as well as a t2g table denoting which transcripts belong to which genes. There is also a bamfiles component, designed to hold paths to the read alignment files for each sample. The bamfiles component isn't currently used by any ballgown functions, but it could come in handy for users of RSamtools or similar packages. Here are some examples of how to extract indexes components from ballgown objects:
exon_transcript_table = indexes(bg)$e2t
transcript_gene_table = indexes(bg)$t2g
head(transcript_gene_table)
## t_id g_id
## 1 10 XLOC_000010
## 2 25 XLOC_000014
## 3 35 XLOC_000017
## 4 41 XLOC_000246
## 5 45 XLOC_000019
## 6 67 XLOC_000255
phenotype_table = pData(bg)
The dirs slot gives full filepaths to Tablemaker output:
head(bg@dirs)
## sample01
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample01"
## sample02
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample02"
## sample03
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample03"
## sample04
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample04"
## sample05
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample05"
## sample06
## "D:/biocbuild/bbs-3.14-bioc/tmpdir/RtmponGsTb/Rinstf9489194c/ballgown/extdata/sample06"
The mergedDate slot indicates when the ballgown object was created:
bg@mergedDate
## [1] "Mon Aug 30 19:23:04 2021"
And the meas slot gives the expression measurements present in the object:
bg@meas
## [1] "all"
Visualization of the assembled transcripts is done with the plotTranscripts function. Transcripts or exons can be colored by expression level. This plot colors transcripts by expression level:
plotTranscripts(gene='XLOC_000454', gown=bg, samples='sample12',
meas='FPKM', colorby='transcript',
main='transcripts from gene XLOC_000454: sample 12, FPKM')
It is also possible to plot several samples at once:
plotTranscripts('XLOC_000454', bg,
samples=c('sample01', 'sample06', 'sample12', 'sample19'),
meas='FPKM', colorby='transcript')
You can also make side-by-side plots comparing mean abundances between groups (here, 0 and 1):
plotMeans('XLOC_000454', bg, groupvar='group', meas='FPKM', colorby='transcript')
Ballgown provides a wide selection of simple, fast statistical methods for testing whether transcripts are differentially expressed between experimental conditions or across a continuous covariate (such as time).
The default statistical test in ballgown is a parametric F-test comparing nested linear models; details are available in the Ballgown manuscript (Frazee et al. (2014)). These models are conceptually simialar to the models used by Smyth (2005) in the limma package. In limma, more sophisticated empirical Bayes shrinkage methods are used, and generally a single linear model is fit per feature instead of doing a nested model comparison, but the flavor is similar (and in fact, limma can easily be run on any of the data matrices in a ballgown object).
Ballgown's statistical models are implemented with the stattest function. Two models are fit to each feature, using expression as the outcome: one including the covariate of interest (e.g., case/control status or time) and one not including that covariate. An F statistic and p-value are calculated using the fits of the two models. A significant p-value means the model including the covariate of interest fits significantly better than the model without that covariate, indicating differential expression. We adjust for multiple testing by reporting q-values (Storey & Tibshirani (2003)) for each transcript in addition to p-values: reporting features with, say, q < 0.05 means the false discovery rate should be controlled at about 5%.
stattest automatically handles two-group (e.g. case/control) comparisons, multi-group comparisons (e.g. comparison of several tissue types), and “timecourse” comparisons (with the scare quotes meaning that these comparisons are also applicable to continuous covariates that aren't time). For two- and multi-group comparisons, a significant result indicates that the feature is differentially expressed in at least one of the groups. For timecourse comparisions, significant results mean the feature has an expression profile that varies significantly over time (i.e., values of the continuous covariate) as opposed to being flat over time.
The example dataset bg contains two group labels, 0 and 1. We can test each transcript for differential expression with stattest:
stat_results = stattest(bg, feature='transcript', meas='FPKM', covariate='group')
head(stat_results)
## feature id pval qval
## 1 transcript 10 0.01381576 0.10521233
## 2 transcript 25 0.26773622 0.79114975
## 3 transcript 35 0.01085070 0.08951825
## 4 transcript 41 0.47108019 0.90253747
## 5 transcript 45 0.08402948 0.48934813
## 6 transcript 67 0.27317385 0.79114975
The result is a data frame containing the feature tested, feature ids, and corresponding p- and q-values. See ?stattest for further usage details.
For timecourse experiments, a smooth curve is fit to time (or the continuous covariate) using natural splines. The default degrees of freedom used for the spline model is 4, but this can be adjusted with the df option. The model for expression including these spline terms is compared to a model without any spline terms for the F-test. The results indicate which features' expression levels change significantly over time. For our example, we can define a “time” covariate and then demonstrate a typical call to stattest for a timecourse experiment:
pData(bg) = data.frame(pData(bg), time=rep(1:10, 2)) #dummy time covariate
timecourse_results = stattest(bg, feature='transcript', meas='FPKM', covariate='time', timecourse=TRUE)
The timecourse option assumes that “time” in your study is truly continuous, i.e., that it takes several values along a time scale. If you have very few timepoints (e.g., fewer than 5), we recommend treating time as a categorical variable, since having very few values does not give much granularity for fitting a smooth curve using splines. You can do this by setting covariate equal to 'time' (or whatever your time variable is named) and simply leaving timecourse as FALSE, its default. If you don't have more timepoints than degrees of freedom in the spline model, a warning will be printed and time will be coerced to categorical.
You can adjust for any or all variables in pData when testing for differential expression. Ballgown automatically adjusts for library size using the sum of all logged nonzero expression measurements below the 75th percentile of those measurements, for each sample. If you would like to adjust for other variables, just provide those confounders as the adjustvars argument to stattest:
group_adj_timecourse_results = stattest(bg, feature='transcript', meas='FPKM', covariate='time',
timecourse=TRUE, adjustvars='group')
It is also possible to explicitly provide the design matrices for the models to be compared. You can provide any two models for mod and mod0, provided that mod0 is nested in mod, i.e., that all covariates used in mod0 also appear in mod. For example, suppose we had sex and age information available, in addition to group and time, and we wanted to compare a model (mod) including all information (sex, age, group, time) to a model including only group and time (mod). Code to do this with ballgown is:
# create example data:
set.seed(43)
sex = sample(c('M','F'), size=nrow(pData(bg)), replace=TRUE)
age = sample(21:52, size=nrow(pData(bg)), replace=TRUE)
# create design matrices:
mod = model.matrix(~ sex + age + pData(bg)$group + pData(bg)$time)
mod0 = model.matrix(~ pData(bg)$group + pData(bg)$time)
# run differential expression tests:
adjusted_results = stattest(bg, feature='transcript', meas='FPKM', mod0=mod0, mod=mod)
head(adjusted_results)
## feature id pval qval
## 1 transcript 10 0.3506799 0.8831885
## 2 transcript 25 0.4220214 0.8831885
## 3 transcript 35 0.5559817 0.9023309
## 4 transcript 41 0.8012697 0.9230539
## 5 transcript 45 0.8764350 0.9230539
## 6 transcript 67 0.8012261 0.9230539
Ballgown's statistical methods for differential expression testing are straightforward and accurate (Frazee et al. (2014)), but users may wish to use one of the many existing packages for differential expression. Ballgown's data structures make it easy to use table-based packages like limma (Smyth (2005)), limma Voom (Law et al. (2014)), DESeq (Anders & Huber (2010)), DEXSeq (Anders et al. (2012)), or EdgeR (Robinson et al. (2010)) for differential expression analysis. A feature-by-sample expression table can be easily created with a *expr function and used directly as input to these or other differential expression packages.
Sometimes several very similar transcripts are assembled for the same gene, which might cause expression estimates for those transcripts to be unreliable: statistically, it can very difficult or impossible to tell which of two very similar transcript a read came from. This means differential expression results might also be unreliable.
As a preliminary attempt at addressing this issue, Ballgown provides some simple transcript clustering functions. The idea is that similar assembled transcripts can be grouped together in clusters, and differential expression analysis could be performed on the cluster, whose expression measurement aggregates the expression estimates of the transcripts that compose it.
These functions measure the distance between transcripts using Jaccard distance, where each transcript's “set” is the nucleotides included in its exons. Transcripts can be clustered using either k-means clustering or hierarchical clustering.
clusterTranscripts(gene='XLOC_000454', gown=bg, k=2, method='kmeans')
## $clusters
## cluster t_id
## 1 2 1294
## 2 1 1297
## 3 2 1301
##
## $pctvar
## [1] 0.9117737
You can also visualize the transcript clusters:
plotLatentTranscripts(gene='XLOC_000454', gown=bg, k=2, method='kmeans', returncluster=FALSE)
And you can calculate aggregate cluster expression measurements for some gene using collapseTranscripts. The tab result of collapseTranscripts can be passed to stattest as the gowntable argument, for differential expression analysis of the clusters:
agg = collapseTranscripts(gene='XLOC_000454', gown=bg, k=2, method='kmeans')
stattest(gowntable=agg$tab, pData=pData(bg), feature='transcript_cluster',
covariate='group', libadjust=FALSE)
## feature id pval qval
## 1 transcript_cluster 1 0.3332238 0.6664477
## 2 transcript_cluster 2 0.6882119 0.6882119
This example clustered only three transcripts, but we imagine clustering could be useful when many more than three transcripts have been assembled for a single gene.
sessionInfo()
## R version 4.1.1 (2021-08-10)
## Platform: x86_64-w64-mingw32/x64 (64-bit)
## Running under: Windows Server x64 (build 17763)
##
## Matrix products: default
##
## locale:
## [1] LC_COLLATE=C
## [2] LC_CTYPE=English_United States.1252
## [3] LC_MONETARY=English_United States.1252
## [4] LC_NUMERIC=C
## [5] LC_TIME=English_United States.1252
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] ballgown_2.25.1
##
## loaded via a namespace (and not attached):
## [1] SummarizedExperiment_1.23.4 KEGGREST_1.33.0
## [3] genefilter_1.75.1 locfit_1.5-9.4
## [5] xfun_0.25 splines_4.1.1
## [7] lattice_0.20-44 vctrs_0.3.8
## [9] stats4_4.1.1 rtracklayer_1.53.1
## [11] yaml_2.2.1 mgcv_1.8-36
## [13] blob_1.2.2 XML_3.99-0.7
## [15] survival_3.2-13 rlang_0.4.11
## [17] DBI_1.1.1 BiocParallel_1.27.4
## [19] BiocGenerics_0.39.2 bit64_4.0.5
## [21] RColorBrewer_1.1-2 matrixStats_0.60.1
## [23] GenomeInfoDbData_1.2.6 sva_3.41.0
## [25] stringr_1.4.0 zlibbioc_1.39.0
## [27] MatrixGenerics_1.5.4 Biostrings_2.61.2
## [29] evaluate_0.14 memoise_2.0.0
## [31] restfulr_0.0.13 Biobase_2.53.0
## [33] knitr_1.33.8 IRanges_2.27.2
## [35] fastmap_1.1.0 GenomeInfoDb_1.29.5
## [37] parallel_4.1.1 AnnotationDbi_1.55.1
## [39] highr_0.9 Rcpp_1.0.7
## [41] edgeR_3.35.0 xtable_1.8-4
## [43] cachem_1.0.6 limma_3.49.4
## [45] DelayedArray_0.19.1 S4Vectors_0.31.3
## [47] annotate_1.71.0 XVector_0.33.0
## [49] bit_4.0.4 Rsamtools_2.9.1
## [51] rjson_0.2.20 png_0.1-7
## [53] stringi_1.7.4 BiocIO_1.3.0
## [55] GenomicRanges_1.45.0 grid_4.1.1
## [57] tools_4.1.1 bitops_1.0-7
## [59] magrittr_2.0.1 RCurl_1.98-1.4
## [61] RSQLite_2.2.8 crayon_1.4.1
## [63] Matrix_1.3-4 httr_1.4.2
## [65] R6_2.5.1 nlme_3.1-152
## [67] GenomicAlignments_1.29.0 compiler_4.1.1