R/ExtDefinitions.R

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

#' Extension defintions file class
#'
#' @description
#' A class for generating the definitions.yml file of a new extension package.
#'
#' @details
#' This class generates the definitions.yml of a new extension package, needed
#' for definining the new connector.
#'
#' @examples
#' # Generate the biodb definitions.yml file inside "inst" folder:
#' pkgFolder <- file.path(tempfile(), 'biodbFoo')
#' dir.create(pkgFolder, recursive=TRUE)
#' biodb::ExtDefinitions$new(path=pkgFolder, dbName='foo.db',
#'                           dbTitle='Foo database')$generate()
#'
#' @import R6
#' @include ExtFileGenerator.R
#' @export
ExtDefinitions <- R6::R6Class('ExtDefinitions',

inherit=ExtFileGenerator,

public=list(

#' @description
#' Initializer.
#' @param ... See the constructor of ExtFileGenerator for the parameters.
#' offers this possiblity.
#' @return Nothing.
initialize=function(...) {
    super$initialize(template='definitions.yml', folder='inst',
        filename='definitions.yml', ...)

    return(invisible(NULL))
}
))