ExtReadme {biodb}R Documentation

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

Inherited methods

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()
[Package biodb version 1.2.2 Index]