Class: MappingSet

name: mapping set
description: Represents a set of mappings.
from_schema: https://w3id.org/sssom/schema/
rank: 1000
slots:
- curie_map
- mappings
- mapping_set_id
- mapping_set_version
- mapping_set_source
- mapping_set_title
- mapping_set_description
- creator_id
- creator_label
- license
- subject_type
- subject_source
- subject_source_version
- object_type
- object_source
- object_source_version
- predicate_type
- mapping_provider
- mapping_tool
- mapping_tool_version
- mapping_date
- publication_date
- subject_match_field
- object_match_field
- subject_preprocessing
- object_preprocessing
- similarity_measure
- see_also
- issue_tracker
- other
- comment
- extension_definitions
slot_usage:
  license:
    name: license
    required: true

name: mapping set
description: Represents a set of mappings.
from_schema: https://w3id.org/sssom/schema/
rank: 1000
slot_usage:
  license:
    name: license
    required: true
attributes:
  curie_map:
    name: curie_map
    description: A dictionary that contains prefixes as keys and their URI expansions
      as values.
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/225
    - https://github.com/mapping-commons/sssom/pull/349
    - https://github.com/mapping-commons/sssom/blob/master/examples/schema/curie_map.sssom.tsv
    rank: 1000
    alias: curie_map
    owner: mapping set
    domain_of:
    - mapping set
    range: prefix
    multivalued: true
    inlined: true
  mappings:
    name: mappings
    description: Contains a list of mapping objects.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: mappings
    owner: mapping set
    domain_of:
    - mapping set
    range: mapping
    recommended: true
    multivalued: true
    inlined_as_list: true
  mapping_set_id:
    name: mapping_set_id
    description: A globally unique identifier for the mapping set (not each individual
      mapping). Should be IRI, ideally resolvable.
    examples:
    - value: http://purl.obolibrary.org/obo/mondo/mappings/mondo_exactmatch_ncit.sssom.tsv
      description: A persistent URI pointing to the latest version of the Mondo -
        NCIT mapping in the Mondo namespace.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: mapping_set_id
    owner: mapping set
    domain_of:
    - mapping set
    - mapping set reference
    range: uri
    required: true
  mapping_set_version:
    name: mapping_set_version
    description: A version string for the mapping.
    examples:
    - value: '2020-01-01'
      description: A date-based version that indicates that the mapping was published
        on the 1st January in 2021.
    - value: 1.2.1
      description: (A semantic version tag that indicates that this is the 1st major,
        2nd minor version, patch 1 (https://semver.org/).)
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: owl:versionInfo
    alias: mapping_set_version
    owner: mapping set
    domain_of:
    - mapping set
    range: string
  mapping_set_source:
    name: mapping_set_source
    description: A mapping set or set of mapping set that was used to derive the mapping
      set.
    examples:
    - value: http://purl.obolibrary.org/obo/mondo/mappings/2022-05-20/mondo_exactmatch_ncit.sssom.tsv
      description: A persistent, ideally versioned, link to the mapping set from which
        the current mapping set is derived.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: prov:wasDerivedFrom
    alias: mapping_set_source
    owner: mapping set
    domain_of:
    - mapping set
    range: uri
    multivalued: true
  mapping_set_title:
    name: mapping_set_title
    description: The display name of a mapping set.
    examples:
    - value: The Mondo-OMIM mappings by Monarch Initiative.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: dcterms:title
    alias: mapping_set_title
    owner: mapping set
    domain_of:
    - mapping set
    range: string
  mapping_set_description:
    name: mapping_set_description
    description: A description of the mapping set.
    examples:
    - value: This mapping set was produced to integrate human and mouse phenotype
        data at the IMPC. It is primarily used for making mouse phenotypes searchable
        by human synonyms at https://mousephenotype.org/.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: dcterms:description
    alias: mapping_set_description
    owner: mapping set
    domain_of:
    - mapping set
    range: string
  creator_id:
    name: creator_id
    description: Identifies the persons or groups responsible for the creation of
      the mapping. The creator is the agent that put the mapping in its published
      form, which may be different from the author, which is a person that was actively
      involved in the assertion of the mapping. Recommended to be a list of ORCIDs
      or otherwise identifying URIs.
    examples:
    - value: orcid:0000-0002-7356-1779|orcid:0000-0002-6601-2165
      description: The ORCID of the (multiple) creators of the mapping.
    - value: orcid:0000-0002-7356-1779
      description: The ORCID of the creator of the mapping.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: dcterms:creator
    alias: creator_id
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
    multivalued: true
  creator_label:
    name: creator_label
    description: A string identifying the creator of this mapping. In the spirit of
      provenance, consider using creator_id instead.
    examples:
    - value: Nicolas Matentzoglu|Chris Mungall
      description: The human-readable names of the (multiple) creators of the mapping.
    - value: Nicolas Matentzoglu
      description: The human-readable name of the creator of the mapping.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: creator_label
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
    multivalued: true
  license:
    name: license
    description: A url to the license of the mapping. In absence of a license we assume
      no license.
    examples:
    - value: https://creativecommons.org/licenses/by/4.0/
      description: The URI of the Creative Commons Attribution 4.0 International license.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: dcterms:license
    alias: license
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: uri
    required: true
  subject_type:
    name: subject_type
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: The type of entity that is being mapped.
    examples:
    - value: owl:Class
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: subject_type
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: entity_type_enum
  subject_source:
    name: subject_source
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: URI of vocabulary or identifier source for the subject.
    examples:
    - value: obo:mondo.owl
      description: A persistent OBO CURIE pointing to the latest version of the Mondo
        ontology.
    - value: wikidata:Q7876491
      description: A Wikidata identifier for the Uberon ontology resource.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: subject_source
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
  subject_source_version:
    name: subject_source_version
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: Version IRI or version string of the source of the subject term.
    examples:
    - value: http://purl.obolibrary.org/obo/mondo/releases/2021-01-30/mondo.owl
      description: A persistent Version IRI pointing to the Mondo version '2021-01-30'
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: subject_source_version
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  object_type:
    name: object_type
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: The type of entity that is being mapped.
    examples:
    - value: owl:Class
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: object_type
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: entity_type_enum
  object_source:
    name: object_source
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: URI of vocabulary or identifier source for the object.
    examples:
    - value: obo:mondo.owl
      description: A persistent OBO CURIE pointing to the latest version of the Mondo
        ontology.
    - value: wikidata:Q7876491
      description: A Wikidata identifier for the Uberon ontology resource.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: object_source
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
  object_source_version:
    name: object_source_version
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: Version IRI or version string of the source of the object term.
    examples:
    - value: http://purl.obolibrary.org/obo/mondo/releases/2021-01-30/mondo.owl
      description: A persistent Version IRI pointing to the Mondo version '2021-01-30'
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: object_source_version
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  predicate_type:
    name: predicate_type
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: The type of the predicate used to map the subject and object entities.
    examples:
    - value: owl:AnnotationProperty
    - value: owl:ObjectProperty
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/143
    - https://github.com/mapping-commons/sssom/blob/master/examples/schema/predicate-types.sssom.tsv
    rank: 1000
    alias: predicate_type
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: entity_type_enum
  mapping_provider:
    name: mapping_provider
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: URL pointing to the source that provided the mapping, for example
      an ontology that already contains the mappings, or a database from which it
      was derived.
    examples:
    - value: https://www.ohdsi.org/
      description: A URL pointing to the Observational Health Data Sciences and Informatics
        initiative.
    - value: https://monarchinitiative.org/
      description: A URL pointing to the Monarch Initiative Resource.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: mapping_provider
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: uri
  mapping_tool:
    name: mapping_tool
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: A reference to the tool or algorithm that was used to generate the
      mapping. Should be a URL pointing to more info about it, but can be free text.
    examples:
    - value: https://github.com/AgreementMakerLight/AML-Project
      description: A URL pointing to the AgreementMakerLight project.
    - value: AgreementMakerLight
      description: A string (name) denoting the AgreementMakerLight project.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: mapping_tool
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  mapping_tool_version:
    name: mapping_tool_version
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: Version string that denotes the version of the mapping tool used.
    examples:
    - value: v3.2
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: mapping_tool_version
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  mapping_date:
    name: mapping_date
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: The date the mapping was asserted. This is different from the date
      the mapping was published or compiled in a SSSOM file.
    examples:
    - value: '2021-01-01'
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: pav:authoredOn
    alias: mapping_date
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: date
  publication_date:
    name: publication_date
    description: The date the mapping was published. This is different from the date
      the mapping was asserted.
    examples:
    - value: '2021-01-01'
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: dcterms:created
    alias: publication_date
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: date
  subject_match_field:
    name: subject_match_field
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: 'A list of properties, annotations or attributes related to the subject
      that was used to establish the match. This property is recommended for use in
      conjunction with  mapping justifications related to lexical matching, such as
      `semapv:LexicalMatching`.  For additional information see the ''See Also'' section.

      '
    examples:
    - value: rdfs:label
      description: The RDFS label property (rdfs:label) was used to match the subject.
    - value: skos:prefLabel
      description: The SKOS preferred label property (skos:prefLabel) was used to
        match the subject.
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://mapping-commons.github.io/sssom/mapping-justifications/#lexical-matching
    - https://github.com/mapping-commons/sssom/issues/413
    rank: 1000
    alias: subject_match_field
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
    multivalued: true
  object_match_field:
    name: object_match_field
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: 'A list of properties, annotations or attributes related to the object
      that was used to establish the match. This property is recommended for use in
      conjunction with  mapping justifications related to lexical matching, such as
      `semapv:LexicalMatching`.  For additional information see the ''See Also'' section.

      '
    examples:
    - value: rdfs:label
      description: The RDFS label property (rdfs:label) was used to match the object.
    - value: skos:prefLabel
      description: The SKOS preferred label property (skos:prefLabel) was used to
        match the object.
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://mapping-commons.github.io/sssom/mapping-justifications/#lexical-matching
    - https://github.com/mapping-commons/sssom/issues/413
    rank: 1000
    alias: object_match_field
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
    multivalued: true
  subject_preprocessing:
    name: subject_preprocessing
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: Method of preprocessing applied to the fields of the subject. If
      different preprocessing steps were performed on different fields, it is recommended
      to store the match in separate rows.
    examples:
    - value: semapv:Stemming
    - value: semapv:StopWordRemoval
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: subject_preprocessing
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
    multivalued: true
  object_preprocessing:
    name: object_preprocessing
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: Method of preprocessing applied to the fields of the object. If different
      preprocessing steps were performed on different fields, it is recommended to
      store the match in separate rows.
    examples:
    - value: semapv:Stemming
    - value: semapv:StopWordRemoval
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: object_preprocessing
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: EntityReference
    multivalued: true
  similarity_measure:
    name: similarity_measure
    instantiates:
    - sssom:Propagatable
    annotations:
      propagated:
        tag: propagated
        value: true
    description: The measure used for computing a similarity score. This field is
      meant to be used in conjunction with the similarity_score field, to document,
      for example, the lexical or semantic match of a matching algorithm. To make
      processing this field as unambiguous as possible, we recommend using wikidata
      CURIEs, but the type of this field is deliberately unspecified.
    examples:
    - value: https://www.wikidata.org/entity/Q865360
      description: the Wikidata IRI for the Jaccard index measure).
    - value: wikidata:Q865360
      description: the Wikidata CURIE for the Jaccard index measure).
    - value: Levenshtein distance
      description: a score to measure the distance between two character sequences).
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/385
    - https://github.com/mapping-commons/sssom/pull/386
    - https://github.com/mapping-commons/sssom/blob/master/examples/schema/similarity_score.sssom.tsv
    rank: 1000
    alias: similarity_measure
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  see_also:
    name: see_also
    description: A URL specific for the mapping instance. E.g. for kboom we have a
      per-mapping image that shows surrounding axioms that drive probability. Could
      also be a github issue URL that discussed a complicated alignment
    examples:
    - value: https://github.com/mapping-commons/mh_mapping_initiative/pull/41
      description: A URL pointing to the pull request that introduced the mapping.
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/422
    rank: 1000
    slot_uri: rdfs:seeAlso
    alias: see_also
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: uri
    multivalued: true
  issue_tracker:
    name: issue_tracker
    description: A URL location of the issue tracker for this entity.
    examples:
    - value: https://github.com/mapping-commons/mh_mapping_initiative/issues
      description: A URL resolving to the issue tracker of the Mouse-Human mapping
        initiative
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/78
    - https://github.com/mapping-commons/sssom/pull/259
    - https://github.com/mapping-commons/sssom/blob/master/examples/schema/issue_tracker.sssom.tsv
    rank: 1000
    alias: issue_tracker
    owner: mapping set
    domain_of:
    - mapping set
    - mapping registry
    range: uri
  other:
    name: other
    description: Pipe separated list of key value pairs for properties not part of
      the SSSOM spec. Can be used to encode additional provenance data. NOTE. This
      field is not recommended for general use, and should be used sparingly. See
      https://github.com/mapping-commons/sssom/blob/master/examples/schema/extension-slots.sssom.tsv
      for an alternative approach based on extension slots.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    alias: other
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  comment:
    name: comment
    description: Free text field containing either curator notes or text generated
      by tool providing additional informative information.
    examples:
    - value: This mapping is weird in that the hierarchical position of the two terms
        is very different.
      description: A comment explaining a mapping authors reservation on a mapping.
    from_schema: https://w3id.org/sssom/schema/
    rank: 1000
    slot_uri: rdfs:comment
    alias: comment
    owner: mapping set
    domain_of:
    - mapping set
    - mapping
    range: string
  extension_definitions:
    name: extension_definitions
    description: A list that defines the extension slots used in the mapping set.
    from_schema: https://w3id.org/sssom/schema/
    see_also:
    - https://github.com/mapping-commons/sssom/issues/328
    - https://github.com/mapping-commons/sssom/blob/master/examples/schema/extension-slots.sssom.tsv
    rank: 1000
    alias: extension_definitions
    owner: mapping set
    domain_of:
    - mapping set
    range: extension definition
    multivalued: true