Skip to content

Class: ReferenceIngestGuide

Description: A container that holds attributes for the discrete sections of information comprising a Resource Ingest Guide.
classDiagram class ReferenceIngestGuide ReferenceIngestGuide : ingest_info ReferenceIngestGuide --|> IngestInformation : ingest_info ReferenceIngestGuide : name ReferenceIngestGuide : provenance_info ReferenceIngestGuide --|> ProvenanceInformation : provenance_info ReferenceIngestGuide : source_info ReferenceIngestGuide --|> SourceInformation : source_info ReferenceIngestGuide : supporting_data_source_info ReferenceIngestGuide --|> SupportingDataSourceInformation : supporting_data_source_info ReferenceIngestGuide : target_info ReferenceIngestGuide --|> TargetInformation : target_info

Slots

Name Cardinality and Range Inheritance Examples
name:
A human readable name for the RIG.
0..1
String
direct
supporting_data_source_info:
Information about upstream sources of data that are used by an ingested source, to derive the knowledge that we ingest.
*
SupportingDataSourceInformation
direct
source_info:
Information about the source from which content is ingested.
1
SourceInformation
direct
ingest_info:
Information about the rationale and scope of an ingest, including what source content was included and excluded from the ingest, and what additional content might be considered in future iterations.
1
IngestInformation
direct
target_info:
Information about the dataset / knowledge graph output by the ingest, including what types of edges and nodes were produced, modeling rationale, and what modeling changes might be considered in future iterations.
1
TargetInformation
direct
provenance_info:
Information about the provenance of the ingest, including who contributed and how, and links to external provenance-related artifacts (e.g. Github tickets, ingest surveys, etc.)
0..1
ProvenanceInformation
direct

LinkML Source

name: ReferenceIngestGuide
description: A container that holds attributes for the discrete sections of information
  comprising a Resource Ingest Guide.
from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
attributes:
  name:
    name: name
    description: A human readable name for the RIG.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    - SupportingDataSourceInformation
    - SourceInformation
    range: string
  supporting_data_source_info:
    name: supporting_data_source_info
    description: Information about upstream sources of data that are used by an ingested
      source, to derive the knowledge that we ingest.
    comments:
    - This slot is optional, and can be omitted for typical ingest of an external
      knowledge source - as it is mainly relevant for describing "ingest" of data-derived
      KPs like ICEES, COHD, various Multiomics KPs, etc.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    range: SupportingDataSourceInformation
    multivalued: true
  source_info:
    name: source_info
    description: Information about the source from which content is ingested.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    range: SourceInformation
    required: true
  ingest_info:
    name: ingest_info
    description: Information about the rationale and scope of an ingest, including
      what source content was included and excluded from the ingest, and what additional
      content might be considered in future iterations.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    range: IngestInformation
    required: true
  target_info:
    name: target_info
    description: Information about the dataset / knowledge graph output by the ingest,  including
      what types of edges and nodes were produced, modeling rationale,  and what modeling
      changes might be considered in future iterations.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    range: TargetInformation
    required: true
  provenance_info:
    name: provenance_info
    description: Information about the provenance of the ingest, including who contributed
      and how, and links to external provenance-related artifacts (e.g. Github tickets,
      ingest surveys, etc.)
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - ReferenceIngestGuide
    range: ProvenanceInformation