setup: Setup and initialize flowr

Description Usage Arguments Details

View source: R/setup.R

Description

This functions creates a directory structure in user's home directory. Additionally it creates a shortcut to the flowr helper script in ~/bin.

Usage

1
2
3
4
5
6
7
setup(
  bin = "~/bin",
  flow_base_path = opts_flow$get("flow_base_path"),
  flow_run_path = opts_flow$get("flow_run_path"),
  flow_conf_path = opts_flow$get("flow_conf_path"),
  flow_pipe_path = opts_flow$get("flow_pipe_paths")
)

Arguments

bin

path to bin folder

flow_base_path

The base of flowr configuration and execution folders.

flow_run_path

base path to be used for execution of this flow. flowr would create a new time-stamped folder in this base path and use it for logs, scripts etc. The default is retrieved using opts_flow$get("flow_run_path").

flow_conf_path

Flowr configuration folder, used by fetch_conf.

flow_pipe_path

Folder with all pipelines, used by fetch_pipes.

Details

Will add more to this, to identify cluster and aid in other things.


flowr documentation built on March 3, 2021, 1:12 a.m.