getExperimentById: Gets an experiment

In mcneilco/racas: R Package for ACAS

Gets an experiment

Description

Gets an experiment by id or codename, with options of what to get

Usage

getExperimentById(experimentId, include = NULL, errorEnv = NULL,
  lsServerURL = racas::applicationSettings$client.service.persistence.fullpath)

getExperimentByCodeName(experimentCodeName, include = NULL, errorEnv = NULL,
  lsServerURL = racas::applicationSettings$client.service.persistence.fullpath)

Arguments

experimentId	the id of the experiment
include	a character string describing what to include
errorEnv	the environment where errors will be stored to
lsServerURL	the url for the roo server
experimentCodeName	the codename of an experiment

Details

include can be in the list:

• analysisgroups: returns the experiment stub with analysis group stubs

• fullobject: returns the full experiment object (warning: this may be slow if there is a lot of data)

• prettyjsonstub: returns the experiment stub in pretty json format

• prettyjson: returns the full experiment in pretty json format

• analysisgroupvalues: returns the experiment stub with full analysis groups

• analysisgroupstates: returns the experiment stub with analysis group states

If left blank, an experiment stub (with states and values) is returned. The codeName will do the same as include=analysisgroups.

Value

the experiment object, or if it does not exist, addError is run and NULL is returned

mcneilco/racas documentation built on April 19, 2024, 1:12 p.m.