Class: Cluster

Represents an individual execution of a clustering protocol. See the ClusterMember class for clustering results.

classDiagram class Cluster click Cluster href "../Cluster" Table <|-- Cluster click Table href "../Table" Cluster : cluster_id Cluster : description Cluster : entity_type Cluster --> "1" ClusterType : entity_type click ClusterType href "../ClusterType" Cluster : name Cluster : protocol_id

Inheritance

Table
- Cluster

Slots

Name	Cardinality and Range	Description	Inheritance
cluster_id	1 UUID	Internal (CDM) unique identifier for a cluster	direct
description	0..1 String	Brief textual definition or description	direct
name	0..1 String	Name of the cluster, if available	direct
entity_type	1 ClusterType	Type of entity being clustered	direct
protocol_id	0..1 String	Protocol used to generate the cluster	direct

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Cluster
description: Represents an individual execution of a clustering protocol. See the
  ClusterMember class for clustering results.
from_schema: http://kbase.github.io/cdm-schema/cdm_schema
is_a: Table
slots:
- cluster_id
- description
slot_usage:
  cluster_id:
    name: cluster_id
    identifier: true
attributes:
  name:
    name: name
    description: Name of the cluster, if available.
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    domain_of:
    - Cluster
    - Contributor
    - DataSource
    - Event
    - Experiment
    - Name
  entity_type:
    name: entity_type
    description: Type of entity being clustered.
    todos:
    - 'This should be an enum: Protein, Feature, strain/species/other?'
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    rank: 1000
    domain_of:
    - Cluster
    - Entity
    range: ClusterType
    required: true
  protocol_id:
    name: protocol_id
    description: Protocol used to generate the cluster.
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    domain_of:
    - Protocol_X_ProtocolParticipant
    - Cluster
    - Feature
    - Protocol
    - Measurement

Induced

name: Cluster
description: Represents an individual execution of a clustering protocol. See the
  ClusterMember class for clustering results.
from_schema: http://kbase.github.io/cdm-schema/cdm_schema
is_a: Table
slot_usage:
  cluster_id:
    name: cluster_id
    identifier: true
attributes:
  name:
    name: name
    description: Name of the cluster, if available.
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    alias: name
    owner: Cluster
    domain_of:
    - Cluster
    - Contributor
    - DataSource
    - Event
    - Experiment
    - Name
    range: string
  entity_type:
    name: entity_type
    description: Type of entity being clustered.
    todos:
    - 'This should be an enum: Protein, Feature, strain/species/other?'
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    rank: 1000
    alias: entity_type
    owner: Cluster
    domain_of:
    - Cluster
    - Entity
    range: ClusterType
    required: true
  protocol_id:
    name: protocol_id
    description: Protocol used to generate the cluster.
    from_schema: http://kbase.github.io/cdm-schema/cdm_components
    alias: protocol_id
    owner: Cluster
    domain_of:
    - Protocol_X_ProtocolParticipant
    - Cluster
    - Feature
    - Protocol
    - Measurement
    range: string
  cluster_id:
    name: cluster_id
    description: Internal (CDM) unique identifier for a cluster.
    from_schema: http://kbase.github.io/cdm-schema/cdm_schema
    rank: 1000
    identifier: true
    alias: cluster_id
    owner: Cluster
    domain_of:
    - Cluster
    - ClusterMember
    range: UUID
    required: true
  description:
    name: description
    description: Brief textual definition or description.
    from_schema: http://kbase.github.io/cdm-schema/cdm_schema
    rank: 1000
    alias: description
    owner: Cluster
    domain_of:
    - Cluster
    - Event
    - Experiment
    - Project
    - Protein
    - Protocol
    - Sample
    - Identifier
    - Name
    range: string