prepareFileInput: Prepare file input object

Description Usage Arguments Details Value

Description

This function makes sure a module's file input is available to the module.

Usage

1
prepareFileInput(vessel, inputObject, outputDirectory, location)

Arguments

vessel

Module input vessel object

inputObject

File path to input

outputDirectory

File path to module working directory

location

File path to originating module XML file

Details

If input is NULL the module is assumed to be “starting” from a file, and the file referenced in vessel is returned.

Where input is not null, and vessel describes an absolute path to a file this path is returned. If vessel describes a relative path to a file, this file is copied into the module's outputDirectory, and the resulting file is returned.

Value

File path to input file


anhinton/conduit documentation built on May 10, 2019, 11:48 a.m.