SpaDES.core (version 2.1.6)

newModule: Create new module from template

Description

Generate a skeleton for a new SpaDES module, a template for a documentation file, a citation file, a license file, a README.md file, and a folder that contains unit tests information. newModule is largely a wrapper around newModuleCode and newModuleDocumentation. newModuleCode will not generate the module code. newModuleDocumentation will create the other files.

Usage

newModule(name, path, ..., events = NULL, envir = parent.frame())
# S4 method for character,character
newModule(name, path, ..., events = NULL, envir = parent.frame())
# S4 method for character,missing
newModule(name, path, ..., events = NULL, envir = parent.frame())
newModuleCode(name, path, ..., events)
# S4 method for character,character
newModuleCode(name, path, ..., events)
newModuleDocumentation(name, path, ...)
# S4 method for character,character
newModuleDocumentation(name, path, ...)
# S4 method for character,missing
newModuleDocumentation(name, path, ...)

Value

NULL (invisibly). The new module file is created at path/name.R, as well as ancillary files for documentation, citation, LICENSE, README, and tests directory.

newModuleCode is invoked for its side effect of creating new module code files.

newModuleDocumentation is invoked for its side effect of creating new module documentation 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.

...

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".

For newModule can also be:

unitTests

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

useGitHub

Logical. Is module development happening on GitHub? Default TRUE.

events

A list of named expressions, each of which is surrounded by { }. A user can specify events here, instead of accepting the default doEvent function that comes with the module template. If this is specified, all events must be specified, i.e., it will not inherit partially from the template doEvent.<moduleName>. See example.

envir

An environment where objects being passed to newModule can be found. Default parent.frame(), which should be fine for most cases.

Author

Alex Chubaty and Eliot McIntire

Eliot McIntire and Alex Chubaty

Details

All files will be created within a subdirectory named name within the path:

  <path>/
    |_ <name>/
    |_ R/               # contains additional module R scripts
    |_ data/            # directory for all included data
      |_ CHECKSUMS.txt  # contains checksums for data files
    |_ tests/           # contains unit tests for module code
    |_ citation.bib     # bibtex citation for the module
    |_ LICENSE          # describes module's legal usage
    |_ README.md        # provide overview of key aspects
    |_ <name>.R         # module code file (incl. metadata)
    |_ <name>.Rmd       # documentation, usage info, etc.

See Also

Other module creation helpers: newModuleTests()

Other module creation helpers: newModuleTests()

Other module creation helpers: newModuleTests()

Examples

# \donttest{
  tmpdir <- tempdir2("exampleNewModule")
  ## create a "myModule" module in the "modules" subdirectory.
  newModule("myModule", tmpdir)

  ## create a new parent module in the "modules" subdirectory.
  newModule("myParentModule", tmpdir, type = "parent", children = c("child1", "child2"))
  unlink(tmpdir, recursive = TRUE)
# }

if (requireNamespace("ggplot2")) {
  # We can also specify events and functions in `newModule`; it will still get all
  #   functions that are not specified from the module template (e.g., plotFun below)
  nm <- "test"
  modulePath <- Require::tempdir2()
  newModule(nm, path = modulePath, open = FALSE,
            events = list(
              init = {
                  sim <- Init(sim)                            # finds definition below
                  sim <- scheduleEvent(sim, start(sim) + 1,
                                       eventType = "plot")
                },
              plot = {
                  plotFun(sim)                                # finds the templated plotFun
                  sim <- scheduleEvent(sim, time(sim) + 1,
                                       eventType = "plot")
                }
              ,
            ),
            Init = function(sim) { # replaces Init definition from template
              sim$a <- 1
              return(sim)
            }
  )
  out <- simInitAndSpades(module = nm, paths = list(modulePath = modulePath))
  # clean up
  unlink(dir(modulePath, pattern = nm, full.names = TRUE), recursive = TRUE)
}