SpaDES.core (version 2.0.5)

newModuleDocumentation: Create new module documentation

Description

Create new module documentation

Usage

newModuleDocumentation(name, path, open, type, children)
# S4 method for character,character,logical,character,character
newModuleDocumentation(name, path, open, type, children)
# S4 method for character,missing,logical,ANY,ANY
newModuleDocumentation(name, open)
# S4 method for character,character,missing,ANY,ANY
newModuleDocumentation(name, path)
# S4 method for character,missing,missing,ANY,ANY
newModuleDocumentation(name)

Value

Nothing is returned. Invoked for its side effect of creating new module code files.

Arguments

name

Character string specifying the name of the new module.

path

Character string. Subdirectory in which to place the new module code file. The default is the current working directory.

open

Logical. Should the new module file be opened after creation? Default TRUE in an interactive session.

type

Character string specifying one of "child" (default), or "parent".

children

Required when type = "parent". A character vector specifying the names of child modules.

Author

Eliot McIntire and Alex Chubaty

See Also

Other module creation helpers: newModule(), newModuleCode(), newModuleTests()