Specification reference

FormalParameter

View this specification's source

Specializations of FormalParameter used in the Workflow Run decoration.

Workflow Run-specific entity. Describes the shape and type of workflow inputs/outputs, providing prospective provenance.

Schema.org type: bioschemas.org/FormalParameter

Reference: ARC WR RO-Crate Profile — FormalParameter

#Properties

PropertyTypeRequiredDescription
@idTextMUSTUnique identifier
@typeTextMUSTbioschemas.org/FormalParameter
additionalTypeTextSHOULDFile, Dataset, Collection, Annotation, or DataType
nameTextSHOULDParameter slot name (should match workflow parameter)
encodingFormatText, URLSHOULDMIME format
descriptionTextCOULDParameter purpose
workExampleIRICOULDData entity realizing this parameter
defaultValueText, ThingCOULDDefault value for input
valueRequiredBooleanCOULDWhether value must be specified

#Relationships

Diagram source
flowchart TD
    WorkflowProtocol --input--> FormalParameter
    WorkflowProtocol --"output"--> FormalParameter
    FormalParameter --workExample--> Data/Annotation