SpaDES.core (version 2.0.5)

citation: A citation method for SpaDES modules

Description

This is a wrapper around utils::citation() for cases with package is a character string. Otherwise, it takes a simList.

Usage

citation(package, lib.loc = NULL, auto = NULL, module = character())
# S4 method for simList
citation(package, lib.loc = NULL, auto = NULL, module = character())
# S4 method for character
citation(package, lib.loc = NULL, auto = NULL, module = character())

Value

The citation information for a SpaDES module.

Arguments

package

For compatibility with utils::citation(). This can be a simList or a character string for a package name.

lib.loc

a character vector with path names of R libraries, or the directory containing the source for package, or NULL. The default value of NULL corresponds to all libraries currently known. If the default is used, the loaded packages are searched before the libraries.

auto

a logical indicating whether the default citation auto-generated from the package DESCRIPTION metadata should be used or not, or NULL (default), indicating that a CITATION file is used if it exists, or an object of class "packageDescription" with package metadata (see below).

module

Optional character string indicating which module params should come from.