Class LABKEY.Exp.Run
Extends
LABKEY.Exp.ExpObject.
The Exp.Run class describes an experiment run. An experiment run is an application of an experimental
protocol to concrete inputs, producing concrete outputs. In object-oriented terminology, a protocol would be a class
while a run would be an instance.
Additional Documentation:
Defined in: Experiment.js.
Constructor Attributes | Constructor Name and Description |
---|---|
LABKEY.Exp.Run(config)
Constructs a new experiment run object.
|
Config Attributes | Config Name and Description |
---|---|
Array of LABKEY.Exp.Data objects that are the inputs to this run.
|
|
Array of LABKEY.Exp.Data objects that are the outputs from this run.
|
|
Array of Objects where each Object corresponds to a row in the results domain.
|
|
Array of LABKEY.Exp.Material objects that are material/sample inputs to the run.
|
|
Array of LABKEY.Exp.Material objects that are material/sample outputs from the run.
|
Method Attributes | Method Name and Description |
---|---|
deleteRun(config)
Deletes the run from the database.
|
Class Detail
LABKEY.Exp.Run(config)
Constructs a new experiment run object.
var result = // ... result of uploading a new assay results file var data = new LABKEY.Exp.Data(result); var run = new LABKEY.Exp.Run(); run.name = data.name; run.properties = { "MyRunProperty" : 3 }; run.dataInputs = [ data ]; data.getContent({ format: 'jsonTSV', success: function (content, format) { data.content = content; var sheet = content.sheets[0]; var filedata = sheet.data; // transform the file content into the dataRows array used by the run run.dataRows = []; for (var i = 1; i < filedata.length; i++) { var row = filedata[i]; run.dataRows.push({ "SampleId": row[0], "DataValue": row[1], // ... other columns }); } var batch = // ... the LABKEY.Exp.RunGroup object batch.runs.push(run); }, failure: function (error, format) { alert("error: " + error); } });
- Parameters:
- {Object} config Optional
- The configuration object. Inherits the config properties of LABKEY.Exp.ExpObject.
Config Detail
{Object[]}
config.dataInputs
Array of LABKEY.Exp.Data objects that are the inputs to this run. Datas typically represent a file on the server's file system.
{Object[]}
config.dataOutputs
Array of LABKEY.Exp.Data objects that are the outputs from this run. Datas typically represent a file on the server's file system.
{Object[]}
config.dataRows
Array of Objects where each Object corresponds to a row in the results domain.
{Object[]}
config.materialInputs
Array of LABKEY.Exp.Material objects that are material/sample inputs to the run.
{Object[]}
config.materialOutputs
Array of LABKEY.Exp.Material objects that are material/sample outputs from the run.
Method Detail
deleteRun(config)
Deletes the run from the database.
- Parameters:
- config
- An object that contains the following configuration parameters
- {Function} config.success
- A reference to a function to call with the API results. This
function will be passed the following parameters:
- data: a simple object with one property called 'success' which will be set to true.
- response: The XMLHttpResponse object
- {Function} config.failure Optional
- A reference to a function to call when an error occurs. This
function will be passed the following parameters:
- errorInfo: an object containing detailed error information (may be null)
- response: The XMLHttpResponse object