inst/templates/README.md

In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases

{{pkgName}}

An R package for accessing {{dbTitle}}, based on R package/framework biodb.

Introduction

This package is an extension of biodb that implements a connector to {{dbTitle}}.

Installation

Install the latest version of this package by running the following commands:

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install('biodb')
devtools::install_github('{{githubRepos}}', dependencies=TRUE)

Examples

To instantiate a connector to {{dbTitle}}, run:

mybiodb <- biodb::Biodb()
conn <- mybiodb$getFactory()$createConn('{{dbName}}')
mybiodb$terminate()

Documentation

To get documentation on the implemented connector, run the following command in R:

?{{pkgName}}::{{connClass}}

Citations

pkrog/biodb documentation built on Nov. 29, 2022, 4:24 a.m.