Name Mode Size
R 040000
data 040000
inst 040000
man 040000
tests 040000
vignettes 040000
.gitignore 100644 0 kb
DESCRIPTION 100644 1 kb
LICENSE 100644 34 kb
NAMESPACE 100644 1 kb 100644 15 kb
[![DOI](]( --- output: html_document --- # BgeeDB, an R package for retrieval of curated expression datasets and for gene list enrichment tests ##### Andrea Komljenović, Julien Roux, Marc Robinson-Rechavi, Frédéric Bastian ```BgeeDB``` is a collection of functions to import data from the Bgee database (<>) directly into R, and to facilitate downstream analyses, such as gene set enrichment test based on expression of genes in anatomical structures. Bgee provides annotated and processed expression data and expression calls from curated wild-type healthy samples, from human and many other animal species. The package retrieves the annotation of RNA-seq or Affymetrix experiments integrated into the Bgee database, and downloads into R the quantitative data and expression calls produced by the Bgee pipeline. The package also allows to run GO-like enrichment analyses based on anatomical terms, where genes are mapped to anatomical terms by expression patterns, based on the ```topGO``` package. This is the same as the TopAnat web-service available at (<>), but with more flexibility in the choice of parameters and developmental stages. In summary, the BgeeDB package allows to: * 1. List annotation of RNA-seq and microarray data available the Bgee database * 2. Download the processed gene expression data available in the Bgee database * 3. Download the gene expression calls and use them to perform TopAnat analyses The pipeline used to generate Bgee expression data is documented and publicly available at (<>) If you found a bug or have any issues to use ```BgeeDB``` please write a bug report in our own GitHub issues manager available at (<>) ## Installation In R: ``` {r} if (!requireNamespace("BiocManager", quietly=TRUE)) install.packages("BiocManager") BiocManager::install("BgeeDB") ``` ## How to use BgeeDB package ### Load the package ``` {r, message = FALSE, warning = FALSE} library(BgeeDB) ``` ### Running example: downloading and formatting processed RNA-seq data #### List available species in Bgee The ```listBgeeSpecies()``` function allows to retrieve available species in the Bgee database, and which data types are available for each species. ``` {r} listBgeeSpecies() ``` It is possible to list all species from a specific release of Bgee with the ```release``` argument (see ```listBgeeRelease()``` function), and order the species according to a specific columns with the ```ordering``` argument. For example: ``` {r} listBgeeSpecies(release = "13.2", order = 2) ``` #### Create a new Bgee object In the following example we will choose to focus on mouse ("Mus\_musculus") RNA-seq. Species can be specified using their name or their NCBI taxonomic IDs. To specify that RNA-seq data want to be downloaded, the ```dataType``` argument is set to "rna\_seq". To download Affymetrix microarray data, set this argument to "affymetrix". ``` {r} bgee <- Bgee$new(species = "Mus_musculus", dataType = "rna_seq") ``` *Note 1*: It is possible to work with data from a specific release of Bgee by specifying the ```release``` argument, see ```listBgeeRelease()``` function. *Note 2*: The functions of the package will store the downloaded files in a versioned folder created by default in the working directory. These cache files allow faster re-access to the data. The directory where data are stored can be changed with the ```pathToData``` argument. #### Retrieve the annotation of mouse RNA-seq datasets The ```getAnnotation()``` function will output the list of RNA-seq experiments and libraries available in Bgee for mouse. ``` {r} annotation_bgee_mouse <- getAnnotation(bgee) # list the first experiments and libraries lapply(annotation_bgee_mouse, head) ``` #### Download the processed mouse RNA-seq data The ```getData()``` function will download processed RNA-seq data from all mouse experiments in Bgee as a list. ``` {r} # download all RNA-seq experiments from mouse data_bgee_mouse <- getData(bgee) # number of experiments downloaded length(data_bgee_mouse) # check the downloaded data lapply(data_bgee_mouse, head) # isolate the first experiment data_bgee_experiment1 <- data_bgee_mouse[[1]] ``` The result of the ```getData()``` function is a data frame. Each row is a gene and the expression levels are displayed as raw read counts, RPKMs (up to Bgee 13.2), TPMs (from Bgee 14.0), or FPKMs (from Bgee 14.0). A detection flag indicates if the gene is significantly expressed above background level of expression. *Note*: If microarray data are downloaded, rows corresponding to probesets and log2 of expression intensities are available instead of read counts/RPKMs/TPMs/FPKMs. Alternatively, you can choose to download data from only one particular RNA-seq experiment from Bgee with the `experimentId` parameter: ``` {r} # download data for GSE30617 data_bgee_mouse_gse30617 <- getData(bgee, experimentId = "GSE30617") ``` #### Format the RNA-seq data It is sometimes easier to work with data organized as a matrix, where rows represent genes or probesets and columns represent different samples. The ```formatData()``` function reformats the data into an ExpressionSet object including: * An expression data matrix, with genes or probesets as rows, and samples as columns (```assayData``` slot). The ```stats``` argument allows to choose if the matrix should be filled with read counts, RPKMs (up to Bgee 13.2), FPKMs (from Bgee 14.0), or TPMs (from Bgee 14.0) for RNA-seq data. For microarray data the matrix is filled with log2 expression intensities. * A data frame listing the samples and their anatomical structure and developmental stage annotation (```phenoData``` slot) * For microarray data, the mapping from probesets to Ensembl genes (```featureData``` slot) The ```callType``` argument allows to retain only actively expressed genes or probesets, if set to "present" or "present high quality". Genes or probesets that are absent in a given sample are given ```NA``` values. ```{r} # use only present calls and fill expression matric with FPKM values gene.expression.mouse.fpkm <- formatData(bgee, data_bgee_mouse_gse30617, callType = "present", stats = "fpkm") gene.expression.mouse.fpkm ``` ### Running example: TopAnat gene expression enrichment analysis For some documentation on the TopAnat analysis, please refer to our publications, or to the web-tool page (<>). #### Create a new Bgee object Similarly to the quantitative data download example above, the first step of a topAnat analysis is to built an object from the Bgee class. For this example, we will focus on zebrafish: ```{r} # Creating new Bgee class object bgee <- Bgee$new(species = "Danio_rerio") ``` *Note* : We are free to specify any data type of interest using the ```dataType``` argument among `rna_seq`, `affymetrix`, `est` or `in_situ`, or even a combination of data types. If nothing is specified, as in the above example, all data types available for the targeted species are used. This equivalent to specifying `dataType=c("rna_seq","affymetrix","est","in_situ")`. #### Download the data allowing to perform TopAnat analysis The ```loadTopAnatData()``` function loads a mapping from genes to anatomical structures based on calls of expression in anatomical structures. It also loads the structure of the anatomical ontology and the names of anatomical structures. ```{r} # Loading calls of expression myTopAnatData <- loadTopAnatData(bgee) # Look at the data str(myTopAnatData) ``` The strigency on the quality of expression calls can be changed with the ```confidence``` argument. Finally, if you are interested in expression data coming from a particular developmental stage or a group of stages, please specify the a Uberon stage Id in the ```stage``` argument. ```{r, eval=FALSE} ## Loading silver and gold expression calls from affymetrix data made on embryonic samples only ## This is just given as an example, *do not run this code* because only few data will be returned by the TopAnat gene expression enrichment analysis bgee <- Bgee$new(species = "Danio_rerio", dataType="affymetrix") myTopAnatData <- loadTopAnatData(bgee, stage="UBERON:0000068", confidence="silver") ``` *Note 1*: As mentioned above, the downloaded data files are stored in a versioned folder that can be set with the ```pathToData``` argument when creating the Bgee class object (default is the working directory). If you query again Bgee with the exact same parameters, these cached files will be read instead of querying the web-service again. **It is thus important, if you plan to reuse the same data for multiple parallel topAnat analyses, to plan to make use of these cached files instead of redownloading them for each analysis.** The cached files also give the possibility to repeat analyses offline. *Note 2*: In releases up to Bgee 13.2 allowed ```confidence`` values were `low_quality` or or `high_quality`. From Bgee 14.0 ```confidence``` values are `gold` or `silver`. #### Prepare a topAnatData object allowing to perform TopAnat analysis with topGO First we need to prepare a list of genes in the foreground and in the background. The input format is the same as the gene list required to build a ```topGOdata``` object in the ```topGO``` package: a vector with background genes as names, and 0 or 1 values depending if a gene is in the foreground or not. In this example we will look at genes with an annotated phenotype related to "pectoral fin" . We use the ```biomaRt``` package to retrieve this list of genes. We expect them to be enriched for expression in male tissues, notably the testes. The background list of genes is set to all genes annotated to at least one Gene Ontology term, allowing to account for biases in which types of genes are more likely to receive Gene Ontology annotation. ```{r} # if (!requireNamespace("BiocManager", quietly=TRUE)) # install.packages("BiocManager") # BiocManager::install("biomaRt") library(biomaRt) ensembl <- useMart("ENSEMBL_MART_ENSEMBL", dataset="drerio_gene_ensembl", host="") # get the mapping of Ensembl genes to phenotypes. It will corresponds to the background genes universe <- getBM(filters=c("phenotype_source"), value=c("ZFIN"), attributes=c("ensembl_gene_id","phenotype_description"), mart=ensembl) # select phenotypes related to pectoral fin phenotypes <- grep("pectoral fin", unique(universe$phenotype_description), value=T) # Foreground genes are those with an annotated phenotype related to "pectoral fin" myGenes <- unique(universe$ensembl_gene_id[universe$phenotype_description %in% phenotypes]) # Prepare the gene list vector geneList <- factor(as.integer(unique(universe$ensembl_gene_id) %in% myGenes)) names(geneList) <- unique(universe$ensembl_gene_id) summary(geneList) # Prepare the topGO object myTopAnatObject <- topAnat(myTopAnatData, geneList) ``` *Warning*: This can be long, especially if the gene list is large, since the Uberon anatomical ontology is large and expression calls will be propagated through the whole ontology (e.g., expression in the forebrain will also be counted as expression in parent structures such as the brain, nervous system, etc). Consider running a script in batch mode if you have multiple analyses to do. #### Launch the enrichment test For this step, see the vignette of the ```topGO``` package for more details, as you have to directly use the tests implemented in the ```topGO``` package, as shown in this example: ```{r} results <- runTest(myTopAnatObject, algorithm = 'weight', statistic = 'fisher') ``` *Warning*: This can be long because of the size of the ontology. Consider running scripts in batch mode if you have multiple analyses to do. #### Format the table of results after an enrichment test for anatomical terms The ```makeTable``` function allows to filter and format the test results, and calculate FDR values. ```{r} # Display results sigificant at a 1% FDR threshold tableOver <- makeTable(myTopAnatData, myTopAnatObject, results, cutoff = 0.01) head(tableOver) ``` At the time of building this README (June 2018), there was 27 significant anatomical structures. The first term is “pectoral fin”, and the second “paired limb/fin bud”. Other terms in the list, especially those with high enrichment folds, are clearly related to pectoral fins or substructures of fins. This analysis shows that genes with phenotypic effects on pectoral fins are specifically expressed in or next to these structures By default results are sorted by p-value, but this can be changed with the ```ordering``` parameter by specifying which column should be used to order the results (preceded by a "-" sign to indicate that ordering should be made in decreasing order). For example, it is often convenient to sort significant structures by decreasing enrichment fold, using `ordering = -6`. The full table of results can be obtained using `cutoff = 1`. Of note, it is possible to retrieve for a particular tissue the significant genes that were mapped to it. ```{r} # In order to retrieve significant genes mapped to the term " paired limb/fin bud" term <- "UBERON:0004357" termStat(myTopAnatObject, term) # 198 genes mapped to this term for Bgee 14.0 and Ensembl 84 genesInTerm(myTopAnatObject, term) # 48 significant genes mapped to this term for Bgee 14.0 and Ensembl 84 annotated <- genesInTerm(myTopAnatObject, term)[["UBERON:0004357"]] annotated[annotated %in% sigGenes(myTopAnatObject)] ``` *Warning*: it is debated whether FDR correction is appropriate on enrichment test results, since tests on different terms of the ontologies are not independent. A nice discussion can be found in the vignette of the ```topGO``` package. #### Store expression data localy Since version 2.14.0 (Bioconductor 3.11) BgeeDB store downloaded expression data in a local RSQLite database. The advantages of this approach compared to the one used in the previous BgeeDB versions are: * do not anymore need a server with lot of memory to access to subset of huge dataset (e.g GTeX dataset) * more granular filtering using arguments in the getData() function * do not download twice the same data * fast access to data once integrated in the local database This approach comes with some drawbacks : * the SQLite local database use more disk space than the previously conpressed .rds approach * first access to a dataset takes more time (integration to SQLite local database is time consuming) It is possible to remove .rds files generated in previous versions of BgeeDB and not used anymore since version 2.14.0. The function below delete all .rds files for the selected species and for all datatype. ```{r eval = FALSE} bgee <- Bgee$new(species="Mus_musculus", release = "14.1") # delete all old .rds files of species Mus musculus deleteOldData(bgee) ``` As the new SQLite approach use more disk space it is now possible to delete all local data of one species from one release of Bgee. ```{r eval = FALSE} bgee <- Bgee$new(species="Mus_musculus", release = "14.1") # delete local SQLite database of species Mus musculus from Bgee 14.1 deleteLocalData(bgee) ```