Skip to contents

Create Module Templates in a Package Repository

Source: R/formods.R
use_formods.Rd

If you are developing a package within a repository (i.e. git) and want to create a new formods module this function will create the template files for you and install them in the correct location.

Usage

use_formods(
  SN = "NM",
  Module_Name = "New Module",
  package = "pkgname",
  element = "analysis",
  overwrite = FALSE,
  repo_root = NULL
)

Arguments

SN

Module short name

Module_Name

Module long name

package

Name of package that will contain the module

element

What you would call the thing the module provides for example the FG module provides "figures", the DW module provides "data views"

overwrite

Boolean to indicate if you should overwrite files

repo_root

Root of the repository.

Value

Same as the return value for new_module_template()

Examples

if(FALSE){
  use_formods(repo_root=tempdir())
}