Learn R Programming
pkgmaker (version 0.10.1)

packageRegistry: Package Registry

Description

Package Registry

Adds a registry to the package

Usage

packageRegistry(name, error = TRUE, package = NULL)
  setPackageRegistry(name, regobj, description = "", ...,
    overwrite = FALSE)

Arguments

name
Name of a sub-registry
error
a logical that indicate whether an error is thrown if the sub-registry is not found (default) or just NULL.
package
package where to look for the registry. If NULL this will defaults to the top caller package.
regobj
a registry object or a single character string that indicates the class of the objects that are stored in the sub-registry.
description
short description line about the registry. It is recommended to provide such description as it makes clearer the purpose of the registry. This description is listed
...
named values used to set extra information about the new registry, that are stored in dedicated fields. Currently not used, as no extra field other than 'description' is defined.
overwrite
a logical that indicate if an existing registry with the same should be overwritten if it exists.

Value

  • a registry object or NULL (see argument error).