Create new module documentation

Description

Create new module documentation

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
newModuleDocumentation(name, path, open, type, children)


  ## S4 method for signature 'character,character,logical,character,character'
newModuleDocumentation(name,
  path, open, type, children)

## S4 method for signature 'character,missing,logical,ANY,ANY'
newModuleDocumentation(name, open)

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

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

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.

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(s)

Eliot McIntire and Alex Chubaty

See Also

Other module creation helpers: newModuleCode, newModuleTests, newModule

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.