R/ExtLicense.R

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

#' Extension license
#'
#' @description
#' A class for generating or upgrading the license of a biodb extension package.
#'
#' @details
#' This class generates the license for a new extension package, or update the
#' license of an existing one.
#'
#' @examples
#' # Generate a new connector class inside R folder:
#' pkgFolder <- file.path(tempfile(), 'biodbFoo')
#' dir.create(pkgFolder, recursive=TRUE)
#' biodb::ExtLicense$new(path=pkgFolder)$generate()
#'
#' @import R6
#' @include ExtFileGenerator.R
#' @export
ExtLicense <- R6::R6Class('ExtLicense',

inherit=ExtFileGenerator,

public=list(

#' @description
#' Initializer.
#' @param ... See the constructor of ExtFileGenerator for the parameters.
#' @return Nothing.
initialize=function(...) {
    super$initialize(filename='LICENSE', ...)
    private$template <- paste0(private$tags$pkgLicense, '.txt')

    return(invisible(NULL))
}
))