Class: AssociationTypeMapping

A data class to hold the necessary information to produce association type counts for given entities with appropriate directional labels. Each match criterion (category, predicate, subject_category, object_category, primary_knowledge_source, provided_by) is an optional list; values within a single criterion are OR'd, and criteria are AND'd together. An omitted criterion places no constraint on that field.

URI: https://w3id.org/monarch/monarch-py/AssociationTypeMapping

 classDiagram
    class AssociationTypeMapping
    click AssociationTypeMapping href "../AssociationTypeMapping/"
      AssociationTypeMapping : category

      AssociationTypeMapping : key

      AssociationTypeMapping : match_criteria





        AssociationTypeMapping --> "0..1" MatchCriteriaEnum : match_criteria
        click MatchCriteriaEnum href "../MatchCriteriaEnum/"



      AssociationTypeMapping : object_category

      AssociationTypeMapping : object_label

      AssociationTypeMapping : predicate

      AssociationTypeMapping : primary_knowledge_source

      AssociationTypeMapping : provided_by

      AssociationTypeMapping : subject_category

      AssociationTypeMapping : subject_label

      AssociationTypeMapping : symmetric

Slots

Name	Cardinality and Range	Description	Inheritance
key	0..1 String	A stable identifier for this association-type section, used to accumulate cou...	direct
match_criteria	0..1 MatchCriteriaEnum	Which declared fields are enforced as Solr filters when selecting an associat...	direct
subject_label	0..1 String	A label to describe the subjects of the association type as a whole for use i...	direct
object_label	0..1 String	A label to describe the objects of the association type as a whole for use in...	direct
symmetric	1 Boolean	Whether the association type is symmetric, meaning that the subject and objec...	direct
category	* String	The biolink association category/categories to match (OR'd)	direct
predicate	* String	The predicate(s) to match (OR'd)	direct
subject_category	* String	The biolink category/categories of entities in the subject position of this a...	direct
object_category	* String	The biolink category/categories of entities in the object position of this as...	direct
primary_knowledge_source	* String	The primary knowledge source(s) to match (OR'd)	direct
provided_by	* String	The provided_by ingest source(s) to match (OR'd)	direct

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/monarch/monarch-py

Mappings

Mapping Type	Mapped Value
self	https://w3id.org/monarch/monarch-py/AssociationTypeMapping
native	https://w3id.org/monarch/monarch-py/AssociationTypeMapping

LinkML Source

Direct

name: AssociationTypeMapping
description: A data class to hold the necessary information to produce association
  type counts for given entities with appropriate directional labels. Each match criterion
  (category, predicate, subject_category, object_category, primary_knowledge_source,
  provided_by) is an optional list; values within a single criterion are OR'd, and
  criteria are AND'd together. An omitted criterion places no constraint on that field.
from_schema: https://w3id.org/monarch/monarch-py
slots:
- key
- match_criteria
- subject_label
- object_label
- symmetric
- category
- predicate
- subject_category
- object_category
- primary_knowledge_source
- provided_by
slot_usage:
  key:
    name: key
    description: A stable identifier for this association-type section, used to accumulate
      counts and as the table/section key. Defaults to the (single) category when
      not set.
  subject_label:
    name: subject_label
    description: A label to describe the subjects of the association type as a whole
      for use in the UI
  object_label:
    name: object_label
    description: A label to describe the objects of the association type as a whole
      for use in the UI
  symmetric:
    name: symmetric
    description: Whether the association type is symmetric, meaning that the subject
      and object labels should be interchangeable
    ifabsent: 'False'
    required: true
  category:
    name: category
    description: The biolink association category/categories to match (OR'd)
    required: false
    multivalued: true
  predicate:
    name: predicate
    description: The predicate(s) to match (OR'd)
    required: false
    multivalued: true
  subject_category:
    name: subject_category
    description: The biolink category/categories of entities in the subject position
      of this association type (OR'd)
    multivalued: true
  object_category:
    name: object_category
    description: The biolink category/categories of entities in the object position
      of this association type (OR'd)
    multivalued: true
  primary_knowledge_source:
    name: primary_knowledge_source
    description: The primary knowledge source(s) to match (OR'd)
    multivalued: true
  provided_by:
    name: provided_by
    description: The provided_by ingest source(s) to match (OR'd)
    multivalued: true

Induced

name: AssociationTypeMapping
description: A data class to hold the necessary information to produce association
  type counts for given entities with appropriate directional labels. Each match criterion
  (category, predicate, subject_category, object_category, primary_knowledge_source,
  provided_by) is an optional list; values within a single criterion are OR'd, and
  criteria are AND'd together. An omitted criterion places no constraint on that field.
from_schema: https://w3id.org/monarch/monarch-py
slot_usage:
  key:
    name: key
    description: A stable identifier for this association-type section, used to accumulate
      counts and as the table/section key. Defaults to the (single) category when
      not set.
  subject_label:
    name: subject_label
    description: A label to describe the subjects of the association type as a whole
      for use in the UI
  object_label:
    name: object_label
    description: A label to describe the objects of the association type as a whole
      for use in the UI
  symmetric:
    name: symmetric
    description: Whether the association type is symmetric, meaning that the subject
      and object labels should be interchangeable
    ifabsent: 'False'
    required: true
  category:
    name: category
    description: The biolink association category/categories to match (OR'd)
    required: false
    multivalued: true
  predicate:
    name: predicate
    description: The predicate(s) to match (OR'd)
    required: false
    multivalued: true
  subject_category:
    name: subject_category
    description: The biolink category/categories of entities in the subject position
      of this association type (OR'd)
    multivalued: true
  object_category:
    name: object_category
    description: The biolink category/categories of entities in the object position
      of this association type (OR'd)
    multivalued: true
  primary_knowledge_source:
    name: primary_knowledge_source
    description: The primary knowledge source(s) to match (OR'd)
    multivalued: true
  provided_by:
    name: provided_by
    description: The provided_by ingest source(s) to match (OR'd)
    multivalued: true
attributes:
  key:
    name: key
    description: A stable identifier for this association-type section, used to accumulate
      counts and as the table/section key. Defaults to the (single) category when
      not set.
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: key
    owner: AssociationTypeMapping
    domain_of:
    - AssociationCount
    - AssociationTypeMapping
    range: string
    multivalued: false
  match_criteria:
    name: match_criteria
    description: Which declared fields are enforced as Solr filters when selecting
      an association type. Defaults to `category`, the behaviour every legacy section
      relies on. Set explicitly rather than inferred from the presence of a key, so
      that adding a key for URL or UI reasons cannot silently change which edges a
      section counts.
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: match_criteria
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    range: MatchCriteriaEnum
    multivalued: false
  subject_label:
    name: subject_label
    description: A label to describe the subjects of the association type as a whole
      for use in the UI
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    is_a: name
    alias: subject_label
    owner: AssociationTypeMapping
    domain_of:
    - CompactAssociation
    - AssociationTypeMapping
    - Mapping
    - AssociationHighlighting
    - TermPairwiseSimilarity
    - Association
    range: string
  object_label:
    name: object_label
    description: A label to describe the objects of the association type as a whole
      for use in the UI
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    is_a: name
    alias: object_label
    owner: AssociationTypeMapping
    domain_of:
    - CompactAssociation
    - AssociationTypeMapping
    - Mapping
    - AssociationHighlighting
    - TermPairwiseSimilarity
    - Association
    range: string
  symmetric:
    name: symmetric
    description: Whether the association type is symmetric, meaning that the subject
      and object labels should be interchangeable
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    ifabsent: 'False'
    alias: symmetric
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    range: boolean
    required: true
  category:
    name: category
    description: The biolink association category/categories to match (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: category
    owner: AssociationTypeMapping
    domain_of:
    - AssociationCount
    - CompactAssociation
    - AssociationTypeMapping
    - GridColumnEntity
    - GridRowEntity
    - Entity
    - Association
    range: string
    required: false
    multivalued: true
  predicate:
    name: predicate
    description: The predicate(s) to match (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: predicate
    owner: AssociationTypeMapping
    domain_of:
    - CompactAssociation
    - AssociationTypeMapping
    - AssociationHighlighting
    - Association
    range: string
    required: false
    multivalued: true
  subject_category:
    name: subject_category
    description: The biolink category/categories of entities in the subject position
      of this association type (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    is_a: category
    alias: subject_category
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    - Association
    range: string
    multivalued: true
  object_category:
    name: object_category
    description: The biolink category/categories of entities in the object position
      of this association type (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    is_a: category
    alias: object_category
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    - Association
    range: string
    multivalued: true
  primary_knowledge_source:
    name: primary_knowledge_source
    description: The primary knowledge source(s) to match (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: primary_knowledge_source
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    - Association
    range: string
    multivalued: true
  provided_by:
    name: provided_by
    description: The provided_by ingest source(s) to match (OR'd)
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: provided_by
    owner: AssociationTypeMapping
    domain_of:
    - AssociationTypeMapping
    - Entity
    - Association
    range: string
    multivalued: true