ExtVignette: Extension vignette class

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

Extension vignette class

Description

A class for generating a vignette example for an extension package.

Details

This class generates a vignette file, serving as example to demonstrate the use of the extension package.

Super classes

biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtVignette

Methods

Public methods

• ExtVignette$new()

• ExtVignette$clone()

Inherited methods

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

---

Method new()

Initializer.

Usage

ExtVignette$new(...)

Arguments

...

See the constructor of ExtFileGenerator for the parameters.

Returns

Nothing.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExtVignette$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::ExtVignette$new(path=pkgFolder, dbName='foo.db',
                       dbTitle='Foo database', vignetteName='main', 
                       firstname='John', lastname='Smith',
                       remote=TRUE)$generate()

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