Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Experiment

Index

Type aliases

LineageNode

LineageRunStep

Variables

Const SAMPLE_DERIVATION_PROTOCOL

SAMPLE_DERIVATION_PROTOCOL: "Sample Derivation Protocol" = 'Sample Derivation Protocol'

The name of the protocol used by Experiment. This can be used for "protocolName".

Functions

createHiddenRunGroup

  • Create or recycle an existing run group. Run groups are the basis for some operations, like comparing MS2 runs to one another.

    Parameters

    Returns XMLHttpRequest

lineage

  • Get parent/child relationships of ExpData, ExpMaterial, or ExpRun.

    Parameters

    Returns XMLHttpRequest

loadBatch

  • Loads a batch from the server. See the Module Assay documentation for more information.

    Examples

    LABKEY.Experiment.loadBatch({
        protocolName: LABKEY.Experiment.SAMPLE_DERIVATION_PROTOCOL,
        batchId: 12
    });
    

    Parameters

    Returns XMLHttpRequest

loadBatches

loadRuns

resolve

saveBatch

  • Saves a modified batch. Runs within the batch may refer to existing data and material objects, either inputs or outputs, by ID or LSID. Runs may also define new data and materials objects by not specifying an ID or LSID in their properties. See the Module Assay documentation for more information.

    Parameters

    • options: SaveBatchOptions

      Examples

      LABKEY.Experiment.saveBatch({
          protocolName: LABKEY.Experiment.SAMPLE_DERIVATION_PROTOCOL,
          batch: {
              properties: {
                  // property URI from a Vocabulary
                  'urn:lsid:labkey.com:Vocabulary.Folder-114:MyVocab#field1': '123'
              },
              runs: [{
                  name: 'two',
                  properties: {
                      // property URI from a Vocabulary
                      'urn:lsid:labkey.com:Vocabulary.Folder-114:MyVocab#field1': '123'
                  }
              }]
          }
      });
      

    Returns XMLHttpRequest

saveBatches

  • Saves an array of modified batches. Runs within the batches may refer to existing data and material objects, either inputs or outputs, by ID or LSID. Runs may also define new data and materials objects by not specifying an ID or LSID in their properties. See the Module Assay documentation for more information.

    Parameters

    Returns XMLHttpRequest

saveMaterials

saveRuns

Generated using TypeDoc