Logo ProcessCore

Dataset Type

Container and context for data and processes. schema.org/Dataset

Constructors

Constructor Description

Dataset(identifier, ?name, ?description, ?additionalType, ?processes, ?hasPart, ?additionalProperty)

Full Usage: Dataset(identifier, ?name, ?description, ?additionalType, ?processes, ?hasPart, ?additionalProperty)

Parameters:
    identifier : string
    ?name : string
    ?description : string
    ?additionalType : string
    ?processes : LabProcess seq
    ?hasPart : Dataset seq
    ?additionalProperty : PropertyValue seq

Returns: Dataset
identifier : string
?name : string
?description : string
?additionalType : string
?processes : LabProcess seq
?hasPart : Dataset seq
?additionalProperty : PropertyValue seq
Returns: Dataset

Instance members

Instance member Description

this.AddAdditionalProperty

Full Usage: this.AddAdditionalProperty

Parameters:

this.AddPart

Full Usage: this.AddPart

Parameters:
child : Dataset

this.AddProcess

Full Usage: this.AddProcess

Parameters:
proc : LabProcess

this.AdditionalProperty

Full Usage: this.AdditionalProperty

Returns: ResizeArray<PropertyValue>
Returns: ResizeArray<PropertyValue>

this.AdditionalType

Full Usage: this.AdditionalType

Returns: string option

Decoration discriminator (e.g. "Investigation", "Study", "Assay")

Returns: string option

this.AllConnectedNodes

Full Usage: this.AllConnectedNodes

Parameters:
Returns: ResizeArray<IONode>

All IONodes connected to `node` within this dataset, excluding `node` itself.

node : IONode
Returns: ResizeArray<IONode>

this.AllData

Full Usage: this.AllData

Returns: ResizeArray<Data>

All distinct Data nodes reachable from processes in this dataset

Returns: ResizeArray<Data>

this.AllMaterials

Full Usage: this.AllMaterials

Returns: ResizeArray<Material>

All distinct Material nodes reachable from processes in this dataset

Returns: ResizeArray<Material>

this.AllNodes

Full Usage: this.AllNodes

Returns: ResizeArray<IONode>

All distinct IONodes (materials and data) from all processes in this dataset.

Returns: ResizeArray<IONode>

this.AllProcesses

Full Usage: this.AllProcesses

Returns: ResizeArray<LabProcess>

All processes in this dataset and all nested datasets (depth-first)

Returns: ResizeArray<LabProcess>

this.AllPropertyValues

Full Usage: this.AllPropertyValues

Parameters:
    ?protocolName : string

Returns: ResizeArray<PropertyValue>

All distinct PropertyValues from all sources across all processes in this dataset. Sources: process parameters, input/output node properties, protocol components. Optional protocolName restricts to processes whose protocol name matches.

?protocolName : string
Returns: ResizeArray<PropertyValue>

this.AllPropertyValuesForNode

Full Usage: this.AllPropertyValuesForNode

Parameters:
Returns: ResizeArray<PropertyValue>
node : IONode
Returns: ResizeArray<PropertyValue>

this.CanonicalizeNode

Full Usage: this.CanonicalizeNode

Parameters:
Returns: IONode

Returns the canonical IONode for `node` from the root registry. Registers and returns `node` itself if its key is not yet present.

node : IONode
Returns: IONode

this.CollapseProcesses

Full Usage: this.CollapseProcesses

Collapse same-named process rows with equal non-I/O state and compatible I/O shape into positional N-to-N lanes on a single representative process.

this.ConnectedDataForNode

Full Usage: this.ConnectedDataForNode

Parameters:
Returns: ResizeArray<Data>
node : IONode
Returns: ResizeArray<Data>

this.ConnectedMaterialsForNode

Full Usage: this.ConnectedMaterialsForNode

Parameters:
Returns: ResizeArray<Material>
node : IONode
Returns: ResizeArray<Material>

this.DataDownstreamOf

Full Usage: this.DataDownstreamOf

Parameters:
Returns: ResizeArray<Data>
node : IONode
Returns: ResizeArray<Data>

this.DataUpstreamOf

Full Usage: this.DataUpstreamOf

Parameters:
Returns: ResizeArray<Data>
node : IONode
Returns: ResizeArray<Data>

this.Description

Full Usage: this.Description

Returns: string option
Returns: string option

this.DownstreamPropertyValuesForNode

Full Usage: this.DownstreamPropertyValuesForNode

Parameters:
    node : IONode
    ?protocolName : string

Returns: ResizeArray<PropertyValue>

PropertyValues from all sources in processes downstream of `node` within this dataset.

node : IONode
?protocolName : string
Returns: ResizeArray<PropertyValue>

this.FinalData

Full Usage: this.FinalData

Returns: ResizeArray<Data>

Final nodes that are Data.

Returns: ResizeArray<Data>

this.FinalMaterials

Full Usage: this.FinalMaterials

Returns: ResizeArray<Material>

Final nodes that are Materials.

Returns: ResizeArray<Material>

this.FinalNodes

Full Usage: this.FinalNodes

Returns: ResizeArray<IONode>

All IONodes in this dataset with no successor process (terminal sinks).

Returns: ResizeArray<IONode>

this.FindProcessesByPropertyName

Full Usage: this.FindProcessesByPropertyName

Parameters:
    paramName : string

Returns: ResizeArray<LabProcess>

All processes that have a PropertyValue (from any source) with the given name (any value).

paramName : string
Returns: ResizeArray<LabProcess>

this.FindProcessesByPropertyValue

Full Usage: this.FindProcessesByPropertyValue

Parameters:
    paramName : string
    paramValue : string

Returns: ResizeArray<LabProcess>

All processes that have a PropertyValue (from any source) with the given name and value.

paramName : string
paramValue : string
Returns: ResizeArray<LabProcess>

this.FindProcessesByProtocolType

Full Usage: this.FindProcessesByProtocolType

Parameters:
    intendedUse : string

Returns: ResizeArray<LabProcess>

All processes whose executed protocol's intendedUse name matches.

intendedUse : string
Returns: ResizeArray<LabProcess>

this.GetFragmentSelectorProviders

Full Usage: this.GetFragmentSelectorProviders

Returns: IFragmentSelectorProvider seq

this.GetProcess

Full Usage: this.GetProcess

Parameters:
    name : string

Returns: LabProcess
name : string
Returns: LabProcess

this.HasPart

Full Usage: this.HasPart

Returns: ResizeArray<Dataset>
Returns: ResizeArray<Dataset>

this.Identifier

Full Usage: this.Identifier

Returns: string
Returns: string

this.MaterialsDownstreamOf

Full Usage: this.MaterialsDownstreamOf

Parameters:
Returns: ResizeArray<Material>
node : IONode
Returns: ResizeArray<Material>

this.MaterialsResultingFromConditionBy

Full Usage: this.MaterialsResultingFromConditionBy

Parameters:
Returns: ResizeArray<Material>

Find qualifying processes by protocol type, then filter their ParameterValues with a caller-supplied predicate. Returns all terminal-output Materials of the downstream subgraphs of qualifying processes.

protocolType : string
paramPredicate : PropertyValue -> bool
Returns: ResizeArray<Material>

this.MaterialsUpstreamOf

Full Usage: this.MaterialsUpstreamOf

Parameters:
Returns: ResizeArray<Material>
node : IONode
Returns: ResizeArray<Material>

this.Name

Full Usage: this.Name

Returns: string option
Returns: string option

this.NodesDownstreamOf

Full Usage: this.NodesDownstreamOf

Parameters:
Returns: ResizeArray<IONode>

All IONodes reachable downstream from `node` within this dataset.

node : IONode
Returns: ResizeArray<IONode>

this.NodesUpstreamOf

Full Usage: this.NodesUpstreamOf

Parameters:
Returns: ResizeArray<IONode>

All IONodes reachable upstream from `node` within this dataset.

node : IONode
Returns: ResizeArray<IONode>

this.PartOf

Full Usage: this.PartOf

Returns: Dataset option

Back-edge: parent dataset

Returns: Dataset option

this.PathsThrough

Full Usage: this.PathsThrough

Parameters:
Returns: ResizeArray<Path>

All maximal Paths through `node` within this dataset.

node : IONode
Returns: ResizeArray<Path>

this.Processes

Full Usage: this.Processes

Returns: ResizeArray<LabProcess>
Returns: ResizeArray<LabProcess>

this.ProcessesForNode

Full Usage: this.ProcessesForNode

Parameters:
Returns: ResizeArray<LabProcess>

All processes in this dataset in which `node` appears as an input or output.

node : IONode
Returns: ResizeArray<LabProcess>

this.PropertyValuesForNode

Full Usage: this.PropertyValuesForNode

Parameters:
    node : IONode
    ?protocolName : string

Returns: ResizeArray<PropertyValue>

All PropertyValues from all sources connected to `node` (upstream + downstream) within this dataset. Optional protocolName restricts to processes whose protocol name matches.

node : IONode
?protocolName : string
Returns: ResizeArray<PropertyValue>

this.ProtocolParametersForNode

Full Usage: this.ProtocolParametersForNode

Parameters:
Returns: ResizeArray<FormalParameter>
node : IONode
Returns: ResizeArray<FormalParameter>

this.RegisterFragmentSelectorProvider

Full Usage: this.RegisterFragmentSelectorProvider

Parameters:

Register a fragment selector provider in the root dataset of this hierarchy.

provider : IFragmentSelectorProvider

this.RemoveAdditionalProperty

Full Usage: this.RemoveAdditionalProperty

Parameters:

this.RemovePart

Full Usage: this.RemovePart

Parameters:
child : Dataset

this.RemoveProcess

Full Usage: this.RemoveProcess

Parameters:
proc : LabProcess

this.RootData

Full Usage: this.RootData

Returns: ResizeArray<Data>

Root nodes that are Data.

Returns: ResizeArray<Data>

this.RootMaterials

Full Usage: this.RootMaterials

Returns: ResizeArray<Material>

Root nodes that are Materials.

Returns: ResizeArray<Material>

this.RootNodes

Full Usage: this.RootNodes

Returns: ResizeArray<IONode>

All IONodes in this dataset with no predecessor process (terminal sources).

Returns: ResizeArray<IONode>

this.TryGetFragmentSelectorProvider

Full Usage: this.TryGetFragmentSelectorProvider

Parameters:
    selectorFormat : string

Returns: IFragmentSelectorProvider option

Returns a fragment selector provider from the root dataset, if registered.

selectorFormat : string
Returns: IFragmentSelectorProvider option

this.TryGetPart

Full Usage: this.TryGetPart

Parameters:
    identifier : string

Returns: Dataset option
identifier : string
Returns: Dataset option

this.TryGetProcess

Full Usage: this.TryGetProcess

Parameters:
    name : string

Returns: LabProcess option
name : string
Returns: LabProcess option

this.UnregisterFragmentSelectorProvider

Full Usage: this.UnregisterFragmentSelectorProvider

Parameters:
    selectorFormat : string

Remove a fragment selector provider from the root dataset.

selectorFormat : string

this.UpstreamPropertyValuesForNode

Full Usage: this.UpstreamPropertyValuesForNode

Parameters:
    node : IONode
    ?protocolName : string

Returns: ResizeArray<PropertyValue>

PropertyValues from all sources in processes upstream of `node` within this dataset.

node : IONode
?protocolName : string
Returns: ResizeArray<PropertyValue>

Type something to start searching.