R/ExtPackageFile.R

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

#' Extension package file class.
#'
#' @description
#' A class for generating the package.R file for a biodb extension.
#'
#' @details
#' This class generates the package.R file, writing a reference to the
#' generated skeleton vignette, and possibly including directives for C++ code.
#'
#' @examples
#' # Generate a new package:
#' pkgFolder <- file.path(tempfile(), 'biodbFoo')
#' dir.create(pkgFolder, recursive=TRUE)
#' biodb::ExtPackageFile$new(path=pkgFolder, dbName='foo.db')$generate()
#'
#' @import R6
#' @include ExtFileGenerator.R
#' @export
ExtPackageFile <- R6::R6Class('ExtPackageFile',

inherit=ExtFileGenerator,

public=list(

#' @description
#' Initializer.
#' @param ... See the constructor of ExtFileGenerator for the parameters.
#' @return Nothing.
initialize=function(...) {
    super$initialize(template='package.R', folder='R', filename='package.R',
        ...)

    return(invisible(NULL))
}
))