Logo ProcessCore

Process Type

Core transformation node. Connects inputs to outputs by executing a recipe. bioschemas.org/LabProcess

Constructors

Constructor Description

Process(name, ?executesRecipe, ?additionalType, ?input, ?output, ?parameterValue)

Full Usage: Process(name, ?executesRecipe, ?additionalType, ?input, ?output, ?parameterValue)

Parameters:
Returns: Process
name : string
?executesRecipe : Recipe
?additionalType : string
?input : IONode
?output : IONode
?parameterValue : Annotation seq
Returns: Process

Instance members

Instance member Description

this.AddParameterValue

Full Usage: this.AddParameterValue

Parameters:

this.AdditionalType

Full Usage: this.AdditionalType

Returns: string option
Returns: string option

this.AnnotationsByName

Full Usage: this.AnnotationsByName

Parameters:
    name : string

Returns: ResizeArray<Annotation>

Annotations from all sources (parameters, input/output node properties, recipe components) whose name matches the given string.

name : string
Returns: ResizeArray<Annotation>

this.CanonicalizeAllNodes

Full Usage: this.CanonicalizeAllNodes

Parameters:

Re-canonicalize all existing inputs and outputs against the given dataset's root registry. Called when the process is added to a dataset after its nodes were already populated. Migrates back-edges if the canonical instance differs.

ds : Dataset

this.ClearInput

Full Usage: this.ClearInput

this.ClearOutput

Full Usage: this.ClearOutput

this.ExecutesRecipe

Full Usage: this.ExecutesRecipe

Returns: Recipe option
Returns: Recipe option

this.GetParameterValue

Full Usage: this.GetParameterValue

Parameters:
    name : string

Returns: Annotation
name : string
Returns: Annotation

this.Input

Full Usage: this.Input

Returns: IONode option
Returns: IONode option

this.InputData

Full Usage: this.InputData

Returns: Data option

Input nodes that are Data.

Returns: Data option

this.InputSample

Full Usage: this.InputSample

Returns: Sample option

Input nodes that are Samples.

Returns: Sample option

this.Name

Full Usage: this.Name

Returns: string
Returns: string

this.Output

Full Usage: this.Output

Returns: IONode option
Returns: IONode option

this.OutputData

Full Usage: this.OutputData

Returns: Data option

Output nodes that are Data.

Returns: Data option

this.OutputSample

Full Usage: this.OutputSample

Returns: Sample option

Output nodes that are Samples.

Returns: Sample option

this.ParameterValue

Full Usage: this.ParameterValue

Returns: ResizeArray<Annotation>
Returns: ResizeArray<Annotation>

this.ProcessOf

Full Usage: this.ProcessOf

Returns: Dataset option

Back-edge: the Dataset this process belongs to

Returns: Dataset option

this.RecipeParameters

Full Usage: this.RecipeParameters

Returns: ResizeArray<FormalParameter>

FormalParameters defined on the recipe executed by this process.

Returns: ResizeArray<FormalParameter>

this.RemoveParameterValue

Full Usage: this.RemoveParameterValue

Parameters:

this.SetInput

Full Usage: this.SetInput

Parameters:

Add input. Resolves the node against the root registry so back-edges are shared when an equal node already exists anywhere in the dataset hierarchy.

node : IONode

this.SetInputData

Full Usage: this.SetInputData

Parameters:
d : Data

this.SetInputSample

Full Usage: this.SetInputSample

Parameters:
m : Sample

this.SetOutput

Full Usage: this.SetOutput

Parameters:

Add output. Resolves the node against the root registry so back-edges are shared when an equal node already exists anywhere in the dataset hierarchy.

node : IONode

this.SetOutputData

Full Usage: this.SetOutputData

Parameters:
d : Data

this.SetOutputSample

Full Usage: this.SetOutputSample

Parameters:
m : Sample

this.TryGetParameterValue

Full Usage: this.TryGetParameterValue

Parameters:
    name : string

Returns: Annotation option
name : string
Returns: Annotation option

Type something to start searching.