R package providing access to the data in the OMA browser, using the REST API. As such, it requires a stable internet connection to operate. All responses are cached in memory, and optionally on disk (see ?setOmaCache). We also provide a similar wrapper for python (https://github.com/DessimozLab/pyOmaDB).
An notebook containing examples of how to use the package is available here.
If you use our package in your work, please consider citing:
Kaleb K, Warwick Vesztrocy A, Altenhoff A and Dessimoz C. Expanding the Orthologous Matrix (OMA) programmatic interfaces: REST API and the OmaDB packages for R and Python. F1000Research 2019, 8:42 (https://doi.org/10.12688/f1000research.17548.2)
The package is available via Bioconductor (https://bioconductor.org) and can be installed as follows:
if (!requireNamespace("BiocManager"))
install.packages("BiocManager")
BiocManager::install('OmaDB')
#load the package
library(OmaDB)
The current version of the package requires R version >= 4.6.
The latest version of the OmaDB package can also be directly installed from the github repository as below:
if (!requireNamespace("BiocManager"))
install.packages("BiocManager")
if (!requireNamespace("remotes"))
install.packages("remotes")
BiocManager::install('DessimozLab/OmaDB')
library(OmaDB)
prot <- getProtein('P53_HUMAN') # a single protein
prot$orthologs # a data.frame, loaded on access
getHOG('P53_HUMAN', members = TRUE)
See browseVignettes('OmaDB') for more examples.
OmaDB is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
OmaDB is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OmaDB. If not, see http://www.gnu.org/licenses/.