1 Introduction

biodbKegg is a biodb extension package that implements a connector to KEGG Compound database (Kanehisa and Goto 2000).

2 Installation

Install using Bioconductor:

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

3 Initialization

The first step in using biodbKegg, is to create an instance of the biodb class BiodbMain from the main biodb package. This is done by calling the constructor of the class:

mybiodb <- biodb::newInst()

During this step the configuration is set up, the cache system is initialized and extension packages are loaded.

We will see at the end of this vignette that the biodb instance needs to be terminated with a call to the terminate() method.

4 Creating a connector to KEGG Compound database

In biodb the connection to a database is handled by a connector instance that you can get from the factory. biodbKegg implements a connector to a remote database. Here is the code to instantiate a connector:

kegg.comp.conn <- mybiodb$getFactory()$createConn('kegg.compound')
## Loading required package: biodbKegg

5 Accessing entries

To retrieve entries, use:

entries <- kegg.comp.conn$getEntry(c('C00133', 'C00751'))
entries
## [[1]]
## Biodb KEGG Compound entry instance C00133.
## 
## [[2]]
## Biodb KEGG Compound entry instance C00751.

To convert a list of entries into a dataframe, run:

x <- mybiodb$entriesToDataframe(entries, compute=FALSE)
x
##   accession monoisotopic.mass formula molecular.mass
## 1    C00133           89.0477 C3H7NO2        89.0932
## 2    C00751          410.3913  C30H50       410.7180
##                                      name   cas.id ncbi.pubchem.comp.id
## 1 D-Alanine;D-2-Aminopropionic acid;D-Ala 338-69-2                 3433
## 2             Squalene;Spinacene;Supraene 111-02-4                 4013
##   chebi.id
## 1    15570
## 2    15440
##                                                                                                                                                                 kegg.reaction.id
## 1 R00399;R00401;R01147;R01148;R01149;R01150;R01225;R01344;R02718;R04369;R04611;R05861;R07651;R08850;R09588;R09595;R11965;R12557;R12812;R12863;R12867;R12871;R12873;R12875;R12904
## 2                                                                                     R02872;R02874;R02875;R02876;R06223;R07322;R07323;R08535;R09712;R10167;R10169;R11401;R12355
##                                                                                                                         kegg.enzyme.id
## 1 1.4.3.3;1.4.3.19;2.1.2.7;2.3.1.263;2.3.2.14;2.6.1.21;3.1.1.103;3.4.13.22;3.4.17.8;5.1.1.1;6.1.1.13;6.1.2.1;6.3.2.4;6.3.2.16;6.3.2.35
## 2                                    1.3.1.96;1.14.14.17;1.14.19.-;1.17.8.1;2.1.1.262;2.5.1.21;4.2.1.123;4.2.1.129;5.4.99.17;5.4.99.37
##                                                                             kegg.pathway.id
## 1                            map00470;map00550;map00552;map01100;map01502;map01503;map04742
## 2 map00100;map00909;map00996;map00999;map01060;map01062;map01066;map01070;map01100;map01110
##   kegg.compound.id lipidmaps.structure.id
## 1           C00133                   <NA>
## 2           C00751         LMPR0106010002

6 Search for compounds of a certain mass

ids <- kegg.comp.conn$searchForEntries(list(monoisotopic.mass=list(value=64, delta=2.0)), max.results=10)
entries <- mybiodb$getFactory()$getEntry('kegg.compound', ids)

7 Add information to a data frame containing KEGG Compound IDs

If you have a data frame containing a column with KEGG Compound IDs, you can add information such as associated KEGG Enzymes, associated KEGG Pathways and KEGG Modules to your data frame, for a specific organism.

For the example we use the list of compound IDs we already have, to construct a data frame:

kegg.comp.ids <- c('C06144', 'C06178', 'C02659')
mydf <- data.frame(kegg.ids=kegg.comp.ids)

Using the addInfo() method of KeggCompoundConn class, we add information about pathways, enzymes and modules for these compounds:

kegg.comp.conn$addInfo(mydf, id.col='kegg.ids', org='mmu')
## INFO  [15:58:11.299] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:13.017] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:14.735] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:16.521] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:18.196] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:19.868] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:21.735] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:23.553] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:25.406] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:27.244] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00960". Retrying connection to server...
## INFO  [15:58:28.999] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:30.861] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:32.546] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:34.372] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:36.068] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:37.878] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:39.725] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:41.531] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:43.340] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:45.134] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01060". Retrying connection to server...
## INFO  [15:58:46.952] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:48.811] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:50.533] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:52.337] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:54.147] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:55.951] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:57.782] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:58:59.589] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:59:01.257] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:59:02.956] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01064". Retrying connection to server...
## INFO  [15:59:04.662] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:06.351] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:08.044] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:09.711] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:11.504] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:13.333] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:15.114] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:16.910] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:18.583] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:20.892] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu01110". Retrying connection to server...
## INFO  [15:59:23.299] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:25.085] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:26.870] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:28.588] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:30.369] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:32.588] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:34.275] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:35.979] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:37.734] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
## INFO  [15:59:39.394] Error when retrieving URL content HTTP error 404 (""). When contacting URL "https://rest.kegg.jp/get/mmu00460". Retrying connection to server...
##   kegg.ids               kegg.enzyme.id
## 1   C06144                     4.2.1.27
## 2   C06178            1.4.3.21|2.3.1.74
## 3   C02659 1.14.14.41|2.4.1.63|3.2.1.21
##                                                 kegg.reaction.id
## 1                                                  R01611;R01367
## 2                      R01853;R02382;R02529|R01613;R07987;R07988
## 3 R10030;R10034;R11597|R03625;R04948;R10037|R00026;R00306;R02558
##     kegg.pathway.id
## 1 mmu00650|mmu01100
## 2 mmu00760|mmu01100
## 3          mmu01100
##                                                                                                     kegg.pathway.name
## 1                   Butanoate metabolism - Mus musculus (house mouse)|Metabolic pathways - Mus musculus (house mouse)
## 2 Nicotinate and nicotinamide metabolism - Mus musculus (house mouse)|Metabolic pathways - Mus musculus (house mouse)
## 3                                                                     Metabolic pathways - Mus musculus (house mouse)
##                           kegg.pathway.pathway.class       kegg.module.id
## 1              Metabolism;Carbohydrate metabolism|NA M00027|M00001|M00002
## 2 Metabolism;Metabolism of cofactors and vitamins|NA M00912|M00001|M00002
## 3                                               <NA> M00001|M00002|M00003
##                                                                                                                                                        kegg.module.name
## 1                   GABA (gamma-Aminobutyrate) shunt|Glycolysis (Embden-Meyerhof pathway), glucose => pyruvate|Glycolysis, core module involving three-carbon compounds
## 2 NAD biosynthesis, tryptophan => quinolinate => NAD|Glycolysis (Embden-Meyerhof pathway), glucose => pyruvate|Glycolysis, core module involving three-carbon compounds
## 3       Glycolysis (Embden-Meyerhof pathway), glucose => pyruvate|Glycolysis, core module involving three-carbon compounds|Gluconeogenesis, oxaloacetate => fructose-6P

Note that, by default, the number of values for each field is limited to 3. Please see the help page of KeggCompoundConn for more information about addInfo(), and a description of all parameters.

The list of organisms is available at https://www.genome.jp/kegg/catalog/org_list.html.

9 Terminate the biodb instance

When done with your biodb instance you have to terminate it, in order to ensure release of resources (file handles, database connection, etc):

mybiodb$terminate()
## INFO  [16:00:04.924] Closing BiodbMain instance...
## INFO  [16:00:04.926] Connector "kegg.compound" deleted.
## INFO  [16:00:04.934] Connector "kegg.enzyme" deleted.
## INFO  [16:00:04.935] Connector "kegg.pathway" deleted.
## INFO  [16:00:04.937] Connector "kegg.module" deleted.
## INFO  [16:00:04.938] Connector "kegg.reaction" deleted.

10 Session information

sessionInfo()
## R version 4.2.1 (2022-06-23)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 20.04.5 LTS
## 
## Matrix products: default
## BLAS:   /home/biocbuild/bbs-3.15-bioc/R/lib/libRblas.so
## LAPACK: /home/biocbuild/bbs-3.15-bioc/R/lib/libRlapack.so
## 
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
##  [3] LC_TIME=en_GB              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] stats     graphics  grDevices utils     datasets  methods   base     
## 
## other attached packages:
## [1] biodbKegg_1.2.1  BiocStyle_2.24.0
## 
## loaded via a namespace (and not attached):
##  [1] progress_1.2.2      tidyselect_1.1.2    xfun_0.33          
##  [4] bslib_0.4.0         purrr_0.3.4         vctrs_0.4.1        
##  [7] generics_0.1.3      htmltools_0.5.3     BiocFileCache_2.4.0
## [10] yaml_2.3.5          utf8_1.2.2          blob_1.2.3         
## [13] XML_3.99-0.10       rlang_1.0.6         jquerylib_0.1.4    
## [16] pillar_1.8.1        withr_2.5.0         glue_1.6.2         
## [19] DBI_1.1.3           rappdirs_0.3.3      bit64_4.0.5        
## [22] dbplyr_2.2.1        lifecycle_1.0.2     plyr_1.8.7         
## [25] stringr_1.4.1       memoise_2.0.1       evaluate_0.16      
## [28] knitr_1.40          fastmap_1.1.0       curl_4.3.2         
## [31] fansi_1.0.3         highr_0.9           biodb_1.4.2        
## [34] Rcpp_1.0.9          openssl_2.0.3       filelock_1.0.2     
## [37] BiocManager_1.30.18 cachem_1.0.6        magick_2.7.3       
## [40] jsonlite_1.8.0      bit_4.0.4           chk_0.8.1          
## [43] askpass_1.1         hms_1.1.2           digest_0.6.29      
## [46] stringi_1.7.8       bookdown_0.29       dplyr_1.0.10       
## [49] bitops_1.0-7        cli_3.4.1           tools_4.2.1        
## [52] magrittr_2.0.3      sass_0.4.2          RCurl_1.98-1.8     
## [55] RSQLite_2.2.17      tibble_3.1.8        crayon_1.5.1       
## [58] pkgconfig_2.0.3     ellipsis_0.3.2      prettyunits_1.1.1  
## [61] assertthat_0.2.1    rmarkdown_2.16      httr_1.4.4         
## [64] lgr_0.4.4           R6_2.5.1            igraph_1.3.5       
## [67] compiler_4.2.1

References

Kanehisa, Minoru, and Susumu Goto. 2000. “KEGG: Kyoto Encyclopedia of Genes and Genomes.” Nucleic Acids Research 28 (1): 27–30. https://doi.org/10.1093/nar/28.1.27.