newModule

0th

Percentile

Create new module from template.

Autogenerate a skeleton for a new SpaDES module, a template for a documentation file, a citation file, a license file, a README.txt file, and a folder that contains unit tests information. The newModuleDocumentation will not generate the module file, but will create the other files.

Usage
newModule(name, path, ...)

# S4 method for character,character newModule(name, path, ...)

# S4 method for character,missing newModule(name, path, ...)

Arguments
name

Character string specfying 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.

...

Additonal arguments. Currently, only the following are supported:

open. Logical. Should the new module file be opened after creation? Default TRUE.

unitTests. Logical. Should the new module include unit test files? Default TRUE. Unit testing relies on the testthat package.

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

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

Details

All files will be created within a subfolder named name within the path.

Value

Nothing is returned. The new module file is created at path/name.R, as well as ancillary files for documentation, citation, license, readme, and unit tests folder.

Note

On Windows there is currently a bug in RStudio that prevents the editor from opening when file.edit is called. Similarly, in RStudio on OS X / macOS, there is an issue opening files where they are opened in an overlayed window rather than a new tab. file.edit does work if the user types it at the command prompt. A message with the correct lines to copy and paste is provided.

See Also

Other module creation helpers: newModuleCode, newModuleDocumentation, newModuleTests

Aliases
  • newModule
  • newModule,character,character-method
  • newModule,character,missing-method
Examples
# NOT RUN {
  ## create a "myModule" module in the "modules" subdirectory.
  newModule("myModule", "modules")

  ## create a new parent module in the "modules" subdirectory.
  newModule("myParentModule", "modules", type = "parent", children = c("child1", "child2"))
# }
# NOT RUN {
# }
Documentation reproduced from package SpaDES, version 1.3.1, License: GPL-3

Community examples

Looks like there are no examples yet.