newModuleDocumentation: Create new module documentation

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Create new module documentation

Description

Create new module documentation

Usage

newModuleDocumentation(name, path, ...)

## S4 method for signature 'character,character'
newModuleDocumentation(name, path, ...)

## S4 method for signature 'character,missing'
newModuleDocumentation(name, path, ...)

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.
...	Additional arguments. Currently, these can be either named function definitions (which will be added to the simList) or one or more of the following: children Required when type = "parent". A character vector specifying the names of child modules. open Logical. Should the new module file be opened after creation? Default TRUE. type Character string specifying one of "child" (default), or "parent".

Value

NULL (invisibly). Invoked for its side effect of creating new module code files.

Author(s)

Eliot McIntire and Alex Chubaty

See Also

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

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.