Class: EdgeType

Description: A structure for describing each type of edge (metaedge) created in the target knowledge graph by this ingest, including what types of edge properties it holds, and a brief explanation of why this modeling pattern was deemed appropriate to represent the source data (for display to end users in a UI system).

classDiagram class EdgeType EdgeType : additional_notes EdgeType : agent_type EdgeType --|> AgentTypeEnum : agent_type EdgeType : biolink_qualifier_1 EdgeType : biolink_qualifier_1_value_type EdgeType : biolink_qualifier_2 EdgeType : biolink_qualifier_2_value_type EdgeType : biolink_qualifier_3 EdgeType : biolink_qualifier_3_value_type EdgeType : edge_properties EdgeType : knowledge_level EdgeType --|> KnowledgeLevelEnum : knowledge_level EdgeType : object_categories EdgeType : predicate EdgeType : qualified_predicate EdgeType : subject_categories EdgeType : ui_explanation

Slots

Name	Cardinality and Range	Inheritance
subject_categories: The Biolink category of the subject node of this edge type. e.g. "biolink:SmallMolecule".	1..* Uriorcurie	direct
predicate: The Biolink predicate that defines this type of edge (e.g. "biolink:treats)	1 Uriorcurie	direct
object_categories: The Biolink category of the object node of this edge type. e.g. "biolink:Disease".	1..* Uriorcurie	direct
qualified_predicate: The Biolink predicate used in a "qualified" reading of a statement expressed by an Edge (i.e. one that considers the semantics added by subject and/or object qualifiers)	0..1 Uriorcurie	direct
biolink_qualifier_1: If relevant, a Biolink qualifier property that defines this edge type. e.g. "biolink:subject_form_or_variant_qualifier".	0..1 Uriorcurie	direct
biolink_qualifier_1_value_type: The type of the value taken by the first qualifier type. Can be reported as the name of a Biolink class, enumeration, or data type, as appropriate. e.g. "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum", "biolink:string".	0..1 Uriorcurie	direct
biolink_qualifier_2: If relevant, a second Biolink qualifier property that defines this edge type. e.g. "biolink:subject_aspect_qualifier".	0..1 Uriorcurie	direct
biolink_qualifier_2_value_type: The type of the value taken by the second qualifier type. Can be reported as the name of a Biolink class, enumeration, or data type, as appropriate. e.g. "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum", "biolink:string".	0..1 Uriorcurie	direct
biolink_qualifier_3: IF relevant, a third Biolink qualifier property that defines this edge type. e.g. "biolink:object_direction_qualifier".	0..1 Uriorcurie	direct
biolink_qualifier_3_value_type: The type of the value taken by the third qualifier type. Can be reported as the name of a Biolink class, enumeration, or data type, as appropriate. e.g. "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum", "biolink:string".	0..1 Uriorcurie	direct
knowledge_level: The knowledge level (or levels) relevant to this type of edge. Multivalued only if instances of this type of edge can have different knowledge levels in the data.	1..* KnowledgeLevelEnum	direct
agent_type: The agent type (or types) relevant to this type of edge. Multivalued only if instances of this type of edge can have different agent types in the data.	1..* AgentTypeEnum	direct
edge_properties: A list of one or more Biolink edge properties used in instances of this edge type in the data.	* Uriorcurie	direct
ui_explanation: A brief explanation of why this modeling pattern was deemed appropriate to represent the source data (for display to end users in a UI system).	1 String	direct
additional_notes: Additional notes, considerations, or explanations of modeling patterns used for this edge type, that were not otherwise captured in dedicated attributes.	0..1 String	direct

Usages

used by	used in	type	used
TargetInformation	edge_type_info	range	EdgeType

LinkML Source

name: EdgeType
description: A structure for describing each type of edge (metaedge) created in the
  target knowledge graph by this ingest, including what types of edge properties it
  holds, and a brief explanation of why this modeling pattern was deemed appropriate
  to represent the source data (for display to end users in a UI system).
from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
attributes:
  subject_categories:
    name: subject_categories
    description: The Biolink category of the subject node of this edge type. e.g.
      "biolink:SmallMolecule".
    comments:
    - If two edge types differ only in their subject category, but use the same predicate,
      object_category, edge properties, and general provenance, they can be described
      together in a single NodeType object that captures the alternative subject categories.
      e.g. if a source provides SmallMolecule-treats-Disease and MolecularMixture-treats-Disease
      edge types, these can be described in a single EdgeType object with two subject
      categories (SmallMolecule and MolecularMixture)
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
    required: true
    multivalued: true
  predicate:
    name: predicate
    description: The Biolink predicate that defines this type of edge (e.g. "biolink:treats)
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
    required: true
  object_categories:
    name: object_categories
    description: The Biolink category of the object node of this edge type. e.g. "biolink:Disease".
    comments:
    - If two edge types differ only in their object category, but use the same predicate,
      subject_category,  edge properties, and general provenance, they can be described
      together in a single NodeType object that captures the alternative object categories.
      e.g. if a source provides Gene-associated_with-Disease and  Gene-associated_with-PhenotypicFeature
      edge types, these can be described in a single EdgeType object with two subject
      categories (Disease and PhenotypicFeature)
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
    required: true
    multivalued: true
  qualified_predicate:
    name: qualified_predicate
    description: The Biolink predicate used in a "qualified" reading of a statement
      expressed by an Edge (i.e. one that considers the semantics added by subject
      and/or object qualifiers)
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_1:
    name: biolink_qualifier_1
    description: If relevant, a Biolink qualifier property that defines this edge
      type. e.g. "biolink:subject_form_or_variant_qualifier".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_1_value_type:
    name: biolink_qualifier_1_value_type
    description: The type of the value taken by the first qualifier type. Can be reported
      as the name of a Biolink class, enumeration, or data type, as appropriate. e.g.
      "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum", "biolink:string".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_2:
    name: biolink_qualifier_2
    description: If relevant, a second Biolink qualifier property that defines this
      edge type. e.g. "biolink:subject_aspect_qualifier".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_2_value_type:
    name: biolink_qualifier_2_value_type
    description: The type of the value taken by the second qualifier type. Can be
      reported as the name of a Biolink class, enumeration, or data type, as appropriate.
      e.g. "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum",
      "biolink:string".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_3:
    name: biolink_qualifier_3
    description: IF relevant, a third Biolink qualifier property that defines this
      edge type. e.g. "biolink:object_direction_qualifier".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  biolink_qualifier_3_value_type:
    name: biolink_qualifier_3_value_type
    description: The type of the value taken by the third qualifier type. Can be reported
      as the name of a Biolink class, enumeration, or data type, as appropriate. e.g.
      "biolink:Disease", "biolink:GeneOrGeneProductOrChemicalEntityAspectEnum", "biolink:string".
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
  knowledge_level:
    name: knowledge_level
    description: The knowledge level (or levels) relevant to this type of edge. Multivalued
      only if instances of this type of edge can have different knowledge levels in
      the data.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: KnowledgeLevelEnum
    required: true
    multivalued: true
  agent_type:
    name: agent_type
    description: The agent type (or types) relevant to this type of edge. Multivalued
      only if instances of this type of edge can have different agent types in the
      data.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: AgentTypeEnum
    required: true
    multivalued: true
  edge_properties:
    name: edge_properties
    description: A list of one or more Biolink edge properties used in instances of
      this edge type in the data.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: uriorcurie
    multivalued: true
  ui_explanation:
    name: ui_explanation
    description: A brief explanation of why this modeling pattern was deemed appropriate
      to represent the source data (for display to end users in a UI system).
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - EdgeType
    range: string
    required: true
  additional_notes:
    name: additional_notes
    description: Additional notes, considerations, or explanations of modeling patterns
      used for this edge type, that were not otherwise captured in dedicated attributes.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - SourceInformation
    - IngestInformation
    - TargetInformation
    - EdgeType
    - NodeType
    range: string