getExperimentContainersAndExperimentSamples: getExperimentContainersAndExperimentSamples - Gets the...

In AmundsenJunior/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

getExperimentContainersAndExperimentSamples - Gets the experiment container, container type and experiment samples of an experiment.

Usage

getExperimentContainersAndExperimentSamples(coreApi, experimentType,
  experimentBarcode, includeExperimentSamples = TRUE,
  fullMetadata = FALSE, ...)

Arguments

experimentType	entity type which has the attribute metadata
experimentBarcode	barcode of entity to get
includeExperimentSamples	get experiment sample associated to containers of an experiment, default FALSE
fullMetadata	get full metadata, default is FALSE
...	additional arguments passed to apiGET
coreAPI	coreApi object with valid jsessionid

Value

List of length 2, containing entity and response objects:

• entity list with experiment container, container type and experiment samples of an experiment.

• response is the entire HTTP response.

Author(s)

Natasha Mora [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
experimentSampleLotNames <- getExperimentContainersAndExperimentSamples(login$coreApi, "experimentType", "EXP123", FALSE)
logOut(login$coreApi)

## End(Not run)
Specific data can be extracted, one example is to extract the container barcodes:
## Not run: 
containerBarcode <- sapply(
    result$entity[[contExpansion]], 
    #contExpansion is "REV_CONTAINER_EXPERIMENT_EXPERIMENT_CONTAINER" or "EXPERIMENT_CONTAINERS" depending on the PFS version.
    FUN = function(x) {
        x$Barcode})

## End(Not run)

AmundsenJunior/pfsrsdk documentation built on July 18, 2019, 8:10 p.m.