module_add {ravepipeline} | R Documentation |
Add new 'RAVE' (2.0) module to current project
Description
Creates a 'RAVE' pipeline with additional dashboard module from template.
Usage
module_add(
module_id,
module_label,
path = ".",
type = c("default", "bare", "scheduler", "python"),
...,
pipeline_name = module_id,
overwrite = FALSE
)
Arguments
module_id |
module ID to create, must be unique; users cannot install
two modules with identical module ID. We recommend that
a module ID follows snake format, starting with lab name, for example,
|
module_label |
a friendly label to display in the dashboard |
path |
project root path; default is current directory |
type |
template to choose, options are |
... |
additional configurations to the module such as |
pipeline_name |
the pipeline name to create along with the module;
default is identical to |
overwrite |
whether to overwrite existing module if module with same ID exists; default is false |
Value
Nothing.
Examples
# For demonstrating this example only
project_root <- tempfile()
dir.create(project_root, showWarnings = FALSE, recursive = TRUE)
# Add a module
module_id <- "mylab_my_first_module"
module_add(
module_id = module_id,
module_label = "My Pipeline",
path = project_root
)
# show the structure
cat(
list.files(
project_root,
recursive = TRUE,
full.names = FALSE,
include.dirs = TRUE
),
sep = "\n"
)
unlink(project_root, recursive = TRUE)