labkey.pipeline.getFileStatus: Gets the protocol file status for a pipeline

In Rlabkey: Data Exchange Between R and 'LabKey' Server

Gets the protocol file status for a pipeline

Description

Gets the status of analysis using a particular protocol for a particular pipeline.

Usage

labkey.pipeline.getFileStatus(baseUrl=NULL, folderPath,
        taskId, protocolName, path, files)

Arguments

baseUrl	a string specifying the baseUrl for the LabKey server
folderPath	a string specifying the folderPath
taskId	a string identifier for the pipeline
protocolName	a string name of the analysis protocol
path	a string for the relative path from the folder's pipeline root
files	a list of names of the files within the subdirectory described by the path property

Value

The response will contain a list of file status objects, i.e. files, each of which will have the following properties:

• "name": name of the file

• "status": status of the file

The response will also include the name of the action that would be performed on the files if the user initiated processing, i.e. submitType.

Author(s)

Cory Nathe

See Also

labkey.pipeline.getPipelineContainer, labkey.pipeline.getProtocols, labkey.pipeline.startAnalysis

Examples

## Not run: 

labkey.pipeline.getFileStatus(
    baseUrl="http://labkey/",
    folderPath="home",
    taskId = "pipelinetest:pipeline:r-copy",
    path = "r-copy",
    protocolName = "Test protocol name",
    files = list("sample.txt", "result.txt")
)


## End(Not run)

Rlabkey documentation built on Oct. 23, 2024, 5:06 p.m.