module_add: Add new 'RAVE' (2.0) module to current project

View source: R/module-create.R

module_addR Documentation

Add new 'RAVE' (2.0) module to current project

Description

Add new 'RAVE' (2.0) module to current project

Usage

module_add(
  module_id,
  module_label,
  path = ".",
  type = c("default", "bare", "scheduler"),
  ...,
  pipeline_name = module_id,
  overwrite = FALSE
)

Arguments

module_id

module ID to create, must be unique

module_label

a friendly label to display in the dashboard

path

project root path; default is current directory

type

template to choose, options are 'default' and 'bare'

...

additional configurations to the module such as 'order', 'group', 'badge'

pipeline_name

the pipeline name to create along with the module; default is identical to module_id

overwrite

whether to overwrite existing module if module with same ID exists; default is false

Value

Nothing.


beauchamplab/raveio documentation built on April 24, 2024, 11:20 p.m.