R: Gets the protocols that have been saved for a particular...

labkey.pipeline.getProtocols {Rlabkey} | R Documentation

## Gets the protocols that have been saved for a particular pipeline

### Description

Gets the protocols that have been saved for a particular pipeline.

### Usage

    labkey.pipeline.getProtocols(baseUrl=NULL, folderPath,
            taskId, path, includeWorkbooks = FALSE)

### Arguments

`baseUrl` | a string specifying the `baseUrl` for the LabKey server
`folderPath` | a string specifying the `folderPath`
`taskId` | a string identifier for the pipeline
`path` | a string for the relative path from the folder's pipeline root
`includeWorkbooks` | (optional) If true, protocols from workbooks under the selected container will also be included. Defaults to FALSE.

### Value

The response will contain a list of protocol objects, each of which will have the following properties:

- "name": Name of the saved protocol.

- "description": Description of the saved protocol, if provided.

- "xmlParameters": Bioml representation of the parameters defined by this protocol.

- "jsonParameters": A list representation of the parameters defined by this protocol.

- "containerPath": The container path where this protocol was saved.

The response will also include a defaultProtocolName property representing which of the protocol names is the default.

### Author(s)

Cory Nathe

### See Also

`labkey.pipeline.getPipelineContainer`, `labkey.pipeline.getFileStatus`, `labkey.pipeline.startAnalysis`

### Examples

    labkey.pipeline.getProtocols(
        baseUrl="http://labkey/",
        folderPath="home",
        taskId = "pipelinetest:pipeline:r-copy",
        path = "r-copy",
        includeWorkbooks = FALSE
    )

[Package Rlabkey version 2.8.1 Index]