BgeeCall, a R package for automatic RNA-Seq present/absent gene expression calls generation

Julien Wollbrett, Marc Robinson-Rechavi, Frederic Bastian

2019-10-30

BgeeCall is a collection of functions that uses Bgee expertise to create RNA-Seq gene expression present/absent calls.

The BgeeCall package allows to:

If you find a bug or have any issues with BgeeCall please write a bug report in our GitHub issues manager.

How present/absent calls are generated

In Bgee present/absent gene expression calls for RNA-seq are generated using a threshold specific to each RNA-Seq library, calculated using reads mapped to reference intergenic regions. This is unlike the more usual use of an arbitrary threshold below which a gene is not considered as expressed (e.g log2(TPM) = 1).

Bgee database

Bgee is a database to retrieve and compare gene expression patterns in multiple animal species and produced from multiple data types (RNA-Seq, Affymetrix, in situ hybridization, and EST data). It notably integrates RNA-Seq libraries for 29 species.

Reference intergenic regions

Reference intergenic regions are defined in the Bgee RNA-Seq pipeline. Candidate intergenic regions are defined using gene annotation data. For each species, over all available libraries, reads are mapped to these intergenic regions with kallisto, as well as to genes. This “intergenic expression” is deconvoluted to distinguish reference intergenic from non annotated genes, which have higher expression. Reference intergenic regions are then defined as intergenic regions with low expression level over all RNA-Seq libraries, relative to genes. This step allows not to consider regions wrongly considered as intergenic because of potential gene annotation quality problem as intergenic. For more information please refer to the Bgee RNA-Seq pipeline.

Threshold of present/absent

BgeeCall pipeline allows to download reference intergenic regions resulting from the expertise of the Bgee team. Moreover BgeeCall allows to use these reference intergenic regions to automatically generate gene expression calls for your own RNA-Seq libraries as long as the species is integrated to Bgee The present/absent abundance threshold is calculated for each library using the formula :

\[ \frac {proportion\ of\ reference\ intergenic\ present}{proportion\ of\ protein\ coding\ present} = 0.05 \]

Installation

In R:

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("BgeeCall")

How to use the BgeeCall package

BgeeCall is highly tunable. Do not hesitate to have a look at the reference manual to have a precise descripton of all slots of the 4 main S4 classes (AbundanceMetadata, KallistoMetadata, BgeeMetadata and UserMetadata) or of all available functions. BgeeCall needs kallisto to run. If you do not have kallisto installed you will find more information how to install it here

Load the package

Quick start

With the BgeeCall package it is easy to generate present/absent gene expression calls. The most time comsuming task of this calls generation is the generation of the kallisto transcriptome index. As the time needed for this step depend on the size of the transcriptome, we choose, as an example, the smallest transcriptome file among all species available on Bgee (C. elegans). To generate these calls you will need :

For this vignette we created a toy fastq file example based on the SRX099901 library using the ShortRead R package

In this example we used the Bioconductor AnnotationHub to load transcriptome and gene annotations but you can load them from wherever you want.

Once you have access to transcriptome, gene annotations and your RNA-Seq library, an object of class UserMetadata has to be created.

And that’s it… You can run the generation of your present/absent gene expression calls

#> 
#> Querying Bgee to get intergenic release information...
#> Note: importing `abundance.h5` is typically faster than `abundance.tsv`
#> reading in files with read_tsv
#> 1 
#> summarizing abundance
#> summarizing counts
#> summarizing length
#> Note: importing `abundance.h5` is typically faster than `abundance.tsv`
#> reading in files with read_tsv
#> 1 
#> summarizing abundance
#> summarizing counts
#> summarizing length
#> Generate present/absent expression calls.
#> 
#> TPM cutoff for which 95% of the expressed genes are coding found at TPM = 4.64724e-06

Each analyze generates 5 files and return path to each one of them.

Generate present/absent calls for more than one RNA-Seq library

You will potentialy be also interested to generate present/absent calls on different RNA-Seq libraries, potentially on different species, or using The main function generate_presence_absence() allows to generate present/absent calls from a UserMetadata object but also from a data frame or a tsv file depending on the arguments of the function you use. Please choose one of the three following arguments : - userMetadata : Allows to generate present/absent calls for one RNA-Seq library using one object of the class UserMetadata.
- userDataFrame : Provide a dataframe where each row correspond to one present/absent call generation. It allows to generate present/absent calls on different libraries, species, transcriptome, genome annotations, etc. - userFile : Similar to userDataFrame except that the information are stored in a tsv file. A template of this file called userMetadataTemplate.tsv is available at the root of the package.

Columns of the dataframe or the tsv file are :

Once the file has been fill in expression calls can be generated with :

Reference intergenic sequences

Releases of reference intergenic sequences

Different releases of reference intergenic sequences are available. It is possible to list all these releases :

It is then possible to choose one specific release to create a BgeeMetadata object. Always use the setter method setIntergenicRelease() when changing the release of an already existing BgeeMetadata object.

By default the reference intergenic release used when a BgeeMetadata object is created is the last stable one created by the Bgee team.

Core reference intergenic from Bgee

Core reference intergenic releases are created by the Bgee team when a lot of new RNA-Seq libraries have been manually curated for already existing species and/or for new species. These releases are the only ones with a release number (e.g “0.1”). Each of these releases contains reference intergenic sequences for a list of species. Bgee reference intergenic sequences have been generated using Bgee team expertise. The RNA-Seq libraries were manually curated as healthy and wild type. Quality Control have been done along all steps of generation of these sequences. Reference intergenic sequences have been selected from all potential intergenic regions (see Bgee pipeline). BgeeCall allows to generate gene expression call from Bgee reference intergenic sequences for any RNA-Seq libraries as long as these sequences have been generated by the Bgee team. A tsv file containing all species available for current release of reference intergenic is available here. This file also contains a column describing the number of RNA-Seq libraries used to generated the reference intergenic sequences of each species. It is also possible to list in R all species for which Bgee reference intergenic sequences have been created :

Community reference intergenic

If you want to use BgeeCall on a species for which Bgee does not provide reference intergenic sequences you have the possibility to create them by yourself and share them with the Bgee community by following all steps of this tutorial. Do not forget that the number of RNA-Seq libraries is a key point to the generation of precise reference intergenic sequences. It is possible to list in R all species for which reference intergenic sequences have been created by the community using the following code

If reference intergenic sequences of the species you are interested in are available only from the community release it is then possible to use this release to generate your present/absent calls

Your own reference intergenic

If you generated your own reference intergenic sequences follwowing this tuorial but did not share them for the moment (do not forget to do it…), it is also possible to use BgeeCall with a file containing the sequences. In this case you need to select the custom release and provide the path to the file containing reference intergenic sequences :

Generate present/absent calls at transcript level (beta version)

kallisto generates TPMs at the transcript level. In the Bgee pipeline we summarize this expression at the gene level to calculate our present/absent calls. In BgeeCall it is now possible to generate present/absent calls at the transcript level. Be careful when using this feature as it has not been tested for the moment. To generate such calls you only have to create one object of the class KallistoMetadata and edit the value of one attribute

Tune how to use kallisto

Download or reuse your own kallisto

By default BgeeCall suppose that kallisto is installed. If kallisto is not installed on your computer you can either :

  • let BgeeCall automatically download the version 0.45 of kallisto. BgeeCall will use it to quantify abundance of transcripts. It will only be used by this package and will have no impact on your potential already existing version of kallisto.

Edit kallisto quant attributes

By default kallisto is run with the same parameters that we use in the RNA-Seq Bgee pipeline:

  • single end : “-t 1 –single -l 180 -s 30 –bias”
  • paired end : “-t 1 –bias”

It is possible to modify them and use your favourite kallisto parameters

Choose between two kmer size

By default 2 indexes with 2 different kmer sizes can be used by BgeeCall The default kmer size of kallisto (31) is used for libraries with reads length equal or larger than 50 bp. A kmer size of 15 is used for libraries with reads length smaller than 50 bp. We decided not to allow to tune kmers size because the generation of the index is time consuming and index generation takes even more time with small kmers size (< 15bp). However it is possible to modify the threshold of read length allowing to choose between default and small kmer size.

Generate calls for a subset of RNA-Seq runs

By default gene expression calls are generated using all runs of the RNA-Seq library. It is possible to select only a subset of these runs.

When run IDs are selected, the name output directory combine the library ID and all selected run IDs. In our example the expression calls will be stored in the directory SRX099901_SRR350955_subset.

Modify present/absent threshold

By default the threshold of present/absent is calculated with the formula :

proportion of ref intergenic present / proportion of protein coding present = 0.05

This 0.05 corresponds to the ratio used in the Bgee pipeline. However it is possible to edit this value. Be careful when editing this value as it has a big impact on your present absent.

Generate calls with a simple arborescence of directories

By default the arborescence of directories created by BgeeCall is as simple as possible. the results will be created using the path working_path/intergenic_release/all_results/libraryId. Generating present/absent gene expression calls for the same RNA-Seq library using different transcriptome or annotation versions using this arborescence will overwrite previous results. The UserMetadata class has an attribute simple_arborescence that is TRUE by default. If FALSE, a complexe arborescence of directories containing the name of the annotation and transcriptome files will be created. This complex arborescence will then allow to generate present/absent calls for the same library using different version of transcriptome or annotaiton.

Change directory where calls are saved

By default directories used to save present/absent calls are subdirectories of UserMetadata@working_path. However it is possible to select the directory where you want the calls to be generated.

This output directory will only contains results generated at the RNA-Seq library level. All data generated at species level are still stored using the UserMetadata@working_path. They can then still be reused to generate calls from other libraries of the same species.

#Session Info

sessionInfo()
#> R Under development (unstable) (2019-10-24 r77329)
#> Platform: x86_64-pc-linux-gnu (64-bit)
#> Running under: Ubuntu 18.04.3 LTS
#> 
#> Matrix products: default
#> BLAS:   /home/biocbuild/bbs-3.11-bioc/R/lib/libRblas.so
#> LAPACK: /home/biocbuild/bbs-3.11-bioc/R/lib/libRlapack.so
#> 
#> locale:
#>  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
#>  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=C              
#>  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
#>  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
#>  [9] LC_ADDRESS=C               LC_TELEPHONE=C            
#> [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       
#> 
#> attached base packages:
#> [1] parallel  stats4    stats     graphics  grDevices utils     datasets 
#> [8] methods   base     
#> 
#> other attached packages:
#> [1] rtracklayer_1.47.0   GenomicRanges_1.39.0 GenomeInfoDb_1.23.0 
#> [4] IRanges_2.21.0       S4Vectors_0.25.0     BiocGenerics_0.33.0 
#> [7] BgeeCall_1.3.0      
#> 
#> loaded via a namespace (and not attached):
#>  [1] Biobase_2.47.0                httr_1.4.1                   
#>  [3] bit64_0.9-7                   jsonlite_1.6                 
#>  [5] AnnotationHub_2.19.0          shiny_1.4.0                  
#>  [7] assertthat_0.2.1              interactiveDisplayBase_1.25.0
#>  [9] askpass_1.1                   BiocManager_1.30.9           
#> [11] BiocFileCache_1.11.0          blob_1.2.0                   
#> [13] BSgenome_1.55.0               GenomeInfoDbData_1.2.2       
#> [15] Rsamtools_2.3.0               yaml_2.2.0                   
#> [17] progress_1.2.2                BiocVersion_3.11.0           
#> [19] pillar_1.4.2                  RSQLite_2.1.2                
#> [21] backports_1.1.5               lattice_0.20-38              
#> [23] glue_1.3.1                    digest_0.6.22                
#> [25] promises_1.1.0                XVector_0.27.0               
#> [27] htmltools_0.4.0               httpuv_1.5.2                 
#> [29] Matrix_1.2-17                 XML_3.98-1.20                
#> [31] pkgconfig_2.0.3               biomaRt_2.43.0               
#> [33] zlibbioc_1.33.0               xtable_1.8-4                 
#> [35] purrr_0.3.3                   later_1.0.0                  
#> [37] BiocParallel_1.21.0           tibble_2.1.3                 
#> [39] openssl_1.4.1                 SummarizedExperiment_1.17.0  
#> [41] GenomicFeatures_1.39.0        mime_0.7                     
#> [43] magrittr_1.5                  crayon_1.3.4                 
#> [45] memoise_1.1.0                 evaluate_0.14                
#> [47] tools_4.0.0                   prettyunits_1.0.2            
#> [49] hms_0.5.1                     matrixStats_0.55.0           
#> [51] stringr_1.4.0                 Rhdf5lib_1.9.0               
#> [53] DelayedArray_0.13.0           AnnotationDbi_1.49.0         
#> [55] Biostrings_2.55.0             compiler_4.0.0               
#> [57] rlang_0.4.1                   rhdf5_2.31.0                 
#> [59] grid_4.0.0                    RCurl_1.95-4.12              
#> [61] tximport_1.15.0               rappdirs_0.3.1               
#> [63] bitops_1.0-6                  rmarkdown_1.16               
#> [65] DBI_1.0.0                     curl_4.2                     
#> [67] R6_2.4.0                      GenomicAlignments_1.23.0     
#> [69] knitr_1.25                    dplyr_0.8.3                  
#> [71] fastmap_1.0.1                 bit_1.1-14                   
#> [73] zeallot_0.1.0                 readr_1.3.1                  
#> [75] stringi_1.4.3                 Rcpp_1.0.2                   
#> [77] vctrs_0.2.0                   dbplyr_1.4.2                 
#> [79] tidyselect_0.2.5              xfun_0.10