ri_workflowInit: Initialises the workflow

Description Usage Arguments Value

View source: R/ri_workflowInit.R

Description

Each workflow must be intialised before it can be used. This function performs some checks and sets the project meta data

Usage

1
ri_workflowInit(script, workdir = getwd())

Arguments

script

name of current script

workdir

name of working directory which contains script

Value

nothing

This functions performs checks to assure that the packages git2r, ricmd, and data file are loaded. It also checks if the script exists and is part of a git repository. If any of the checks fails, the function returns an error.

After the checks this function creates the project meta data. This meta data is used when storing data objects into iRODS.


jspijker/ricmdWorkflow documentation built on Dec. 21, 2021, 3:21 a.m.