labkey.experiment.lineage {Rlabkey}R Documentation

Get lineage parent/child relationships for experiment objects

Description

Get lineage parent/child relationships and information for exp objects by LSID(s)

Usage

labkey.experiment.lineage(baseUrl=NULL, folderPath,
    lsids, options = NULL)

Arguments

baseUrl

A string specifying the baseUrl for the labkey server.

folderPath

A string specifying the folderPath to be renamed. Additionally, the container entity id is also valid.

lsids

One or more LSID seed values for the experiment objects to retrieve lineage information for.

options

(optional) A list containing optional parameters specific to the lineage action.

Details

This function retrieves lineage parent/child relationships and information for experiment objects by LSID(s).

Optional parameters (passed via options) include:

Value

Returns a lineage response object based on the LSID seed values provided. The response object contains:

Author(s)

Cory Nathe

Examples

## Not run: 

library(Rlabkey)

labkey.experiment.lineage(
  baseUrl="http://labkey/",
  folderPath = "/home/OriginalFolder",
  lsids=c("urn:lsid:labkey.com:Sample.519.Blood:23", "urn:lsid:labkey.com:Sample.519.Blood:12"),
  options=list(
    parents=TRUE,
    children=TRUE,
    depth=10,
    expType="Material",
    includeProperties=TRUE,
    includeInputsAndOutputs=FALSE,
    includeRunSteps=FALSE
  )
)


## End(Not run)

[Package Rlabkey version 3.4.1 Index]