ExtPackage: Extension package class

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

Extension package class

Description

A class for generating the skeleton of a new extension package.

Details

This class manages the files of an extension package.

It can generate all the files of a new extension package: DESCRIPTION, NEWS, README.md, tests, definitons.yml, etc. Optionnaly it also generates other files like: a .travis.yml file for Travis-CI, a Makefile for easing development on UNIX-like platforms outside of Rstudio.

It can also upgrade files of an existing package like: definitions.yml, Makefile, .travis.yml, LICENSE, etc.

Super class

biodb::ExtGenerator -> ExtPackage

Methods

Public methods

• ExtPackage$new()

• ExtPackage$clone()

Inherited methods

• biodb::ExtGenerator$generate()
• biodb::ExtGenerator$upgrade()

---

Method new()

Initializer.

Usage

ExtPackage$new(...)

Arguments

...

See the constructor of ExtGenerator for the parameters.

Returns

Nothing.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExtPackage$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Generate a new package:
pkgFolder <- file.path(tempfile(), 'biodbFoo')
dir.create(pkgFolder, recursive=TRUE)
biodb::ExtPackage$new(path=pkgFolder, dbName='foo.db',
                        dbTitle='Foo database', rcpp=TRUE,
                        connType='mass', entryType='txt', downloadable=TRUE,
                        remote=TRUE)$generate()

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