Class: Parameter

A parameter in a protocol. Currently specific to computational protocols.

classDiagram class Parameter click Parameter href "../Parameter/" Table <|-- Parameter click Table href "../Table/" Parameter : cardinality Parameter : default Parameter : description Parameter : name Parameter : parameter_id Parameter : parameter_type Parameter --> "0..1" ProtocolParameterType : parameter_type click ProtocolParameterType href "../ProtocolParameterType/" Parameter : required Parameter : value_type

Inheritance

Table
- Parameter

Slots

Name	Cardinality and Range	Description	Inheritance
parameter_id	1 CdmId	Internal (CDM) unique identifier for a parameter of a protocol.	direct
name	0..1 String	A string used as a name or title.	direct
description	0..1 String	Brief textual definition or description.	direct
value_type	0..1 String	The type(s) of the value.	direct
required	0..1 Boolean	Whether or not this parameter must be supplied.	direct
cardinality	0..1 String	The cardinality of the parameter.	direct
default	0..1 String	The default value for the parameter if a value is not supplied.	direct
parameter_type	0..1 ProtocolParameterType	Whether the parameter applies to the protocol input or output.	direct

Usages

used by	used in	type	used
Schema	parameters	range	Parameter

Identifier and Mapping Information

Schema Source

from schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema

Mappings

Mapping Type	Mapped Value
self	kb_cdm:Parameter
native	kb_cdm:Parameter

LinkML Source

Direct

name: Parameter
description: A parameter in a protocol. Currently specific to computational protocols.
from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema
is_a: Table
slots:
- parameter_id
- name
- description
slot_usage:
  parameter_id:
    name: parameter_id
    aliases:
    - protocol_parameter_id
    identifier: true
attributes:
  value_type:
    name: value_type
    description: The type(s) of the value.
    examples:
    - value: boolean
    - value: SomeSpecifiedEnum
    - value: integer
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    domain_of:
    - Parameter
    - Variable
    - VariableValue
  required:
    name: required
    description: Whether or not this parameter must be supplied.
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    domain_of:
    - Parameter
    range: boolean
  cardinality:
    name: cardinality
    description: The cardinality of the parameter.
    examples:
    - value: 0 .. 1
    - value: 1 .. n
    - value: 0 .. 4
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    domain_of:
    - Parameter
  default:
    name: default
    description: The default value for the parameter if a value is not supplied.
    examples:
    - value: 'false'
    - value: '42'
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    domain_of:
    - Parameter
  parameter_type:
    name: parameter_type
    description: Whether the parameter applies to the protocol input or output.
    examples:
    - value: input
    - value: output
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    domain_of:
    - Parameter
    range: ProtocolParameterType

Induced

name: Parameter
description: A parameter in a protocol. Currently specific to computational protocols.
from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema
is_a: Table
slot_usage:
  parameter_id:
    name: parameter_id
    aliases:
    - protocol_parameter_id
    identifier: true
attributes:
  value_type:
    name: value_type
    description: The type(s) of the value.
    examples:
    - value: boolean
    - value: SomeSpecifiedEnum
    - value: integer
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    alias: value_type
    owner: Parameter
    domain_of:
    - Parameter
    - Variable
    - VariableValue
    range: string
  required:
    name: required
    description: Whether or not this parameter must be supplied.
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    alias: required
    owner: Parameter
    domain_of:
    - Parameter
    range: boolean
  cardinality:
    name: cardinality
    description: The cardinality of the parameter.
    examples:
    - value: 0 .. 1
    - value: 1 .. n
    - value: 0 .. 4
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    alias: cardinality
    owner: Parameter
    domain_of:
    - Parameter
    range: string
  default:
    name: default
    description: The default value for the parameter if a value is not supplied.
    examples:
    - value: 'false'
    - value: '42'
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    alias: default
    owner: Parameter
    domain_of:
    - Parameter
    range: string
  parameter_type:
    name: parameter_type
    description: Whether the parameter applies to the protocol input or output.
    examples:
    - value: input
    - value: output
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_protocol
    rank: 1000
    alias: parameter_type
    owner: Parameter
    domain_of:
    - Parameter
    range: ProtocolParameterType
  parameter_id:
    name: parameter_id
    description: Internal (CDM) unique identifier for a parameter of a protocol.
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema
    aliases:
    - protocol_parameter_id
    rank: 1000
    slot_uri: CDM:parameter_id
    identifier: true
    alias: parameter_id
    owner: Parameter
    domain_of:
    - Parameter
    - ProtocolInput
    range: cdm_id
    required: true
  name:
    name: name
    description: A string used as a name or title.
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Parameter
    domain_of:
    - Cluster
    - Event
    - Name
    - Contributor
    - DataSource
    - DataSourceNew
    - License
    - Experiment
    - Parameter
    - Protocol
    - ProtocolExecution
    - Variable
    range: string
  description:
    name: description
    description: Brief textual definition or description.
    from_schema: http://kbase.github.io/cdm-schema/linkml/cdm_schema
    rank: 1000
    alias: description
    owner: Parameter
    domain_of:
    - Cluster
    - Event
    - Identifier
    - Name
    - Project
    - Experiment
    - Parameter
    - Protocol
    - ProtocolExecution
    - Variable
    - Protein
    - Sample
    range: string