new_module_template {formods} | R Documentation |
Makes Template Files for formods New Module
Description
If you want to create a new formods module this function will create the template files for you.
Usage
new_module_template(
SN = "NM",
Module_Name = "New Module",
package = "pkgname",
element = "analysis",
file_dir = tempdir()
)
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". |
file_dir |
Directory to save file |
Value
list with the following elements:
mc: Module components.
server: Server.R file.
yaml: Yaml configureation file.
Each of these is a list with paths to the respective files:
source: Template source.
dest: Destination file name.
dest_full: Full path to the destination file name.
Examples
new_module_template()
[Package formods version 0.1.6 Index]