labkey.experiment.lineage: Get lineage parent/child relationships for experiment objects

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

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:

• parents (boolean) : include parent objects in the lineage

• children (boolean) : include child objects in the lineage

• depth (integer) : the depth of the lineage to retrieve

• expType (string) : the type of experiment objects to retrieve lineage for

• cpasType (string) : the type of CPAS object to retrieve lineage for

• runProtocolLsid (string) : the LSID of the run protocol to retrieve lineage for

• includeProperties (boolean) : include properties in the lineage response

• includeInputsAndOutputs (boolean) : include inputs and outputs in the lineage response

• includeRunSteps (boolean) : include run steps in the lineage response

Value

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

• seeds : the LSID of the object(s) requested

• nodes : an object with LSID keys for each lineage node and values containing the lineage information

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)

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