ExtReadme: Extension README file class

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

Extension README file class

Description

A class for generating a README file for a new extension package.

Details

Write a README file inside package directory, using a template file.

Super classes

biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtReadme

Methods

Public methods

• ExtReadme$new()

• ExtReadme$clone()

Inherited methods

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

---

Method new()

Initializer.

Usage

ExtReadme$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

ExtReadme$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::ExtReadme$new(path=pkgFolder, dbName='foo.db',
                     dbTitle='Foo database')$generate()

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