ecl-logo Documentation

Resource

Resource[specifications]resource

uses provided specifications to create a sample, instrument, operator or waste resource required for a protocol.

Details

  • Resources can be one of the following types: sample, instrument, operator, and waste.
  • Each resource contains a set of mandatory and optional keys that describes its requirements.
  • Sample:
  •      Required keys Sample
  •      Optional keys: Type, Container, Amount, Status, Preparation, Fresh
  • Instrument
  •      Required key: Instrument
  •      Optional keys: Type, Time, DeckLayout
  • Waste
  •      Required key: WasteType
  •      Optional keys: Type, Amount
  • Operator
  •      Required key: Operator,Time
  •      Optional keys: Type
  • Uploading converts a resource into an Object[Resource].
  • Input
    Output
    Messages
  • AmbiguousTypeThe specified Resource has an ambiguous type. Please make sure to correctly specify Sample, Instrument or Operator key for the Resource.
    InvalidResource`1` is invalid. Please run ValidResourceQ with Verbose->Failures to determine and correct any errors.
    MissingPreparedSampleContainerThe given sample `1` is in a container with the DefineName key, but is not located in the contents of that container. Please file a troubleshooting report.

Examples

Basic Examples  (4)

Constructs a sample Resource construct:

Constructs a instrument Resource construct:

Constructs an operator Resource construct:

Construct a waste Resource construct:

Additional Examples  (9)

Allows dereferencing from construct:

Name a resource that needs to be referenced from different fields:

Sample Resource can be a specific sample:

Sample Resource can list multiple acceptable modelContainers:

Sample Resource can be a specified with a unitless amount, indicating a discrete number is required:

Use UpdateCount->False to indicate the UploadResourceStatus should not update the count field in the picked sample when marking the resource as fulfilled:

Instrument Resource be multiple acceptable models:

Instrument Resource can be a specific instrument:

The number of required uses can be specified for a sample resource:

Messages  (7)

AmbiguousType  (1)

Returns $Failed when the resource type is ambiguous:

InvalidResource  (6)

Shows a message when a mandatory key is missing:

Shows a message when specification has invalid keys:

Shows a message when keys have invalid values:

Shows a message when more then one type of model of sample is requested at the same time:

Shows a message when the number of operators is not equal the length of time needed:

Shows a message when the a water resource isn't provided with a container: