Class: IngestInformation

Description: A container for capturing 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.

classDiagram class IngestInformation IngestInformation : additional_notes IngestInformation : filtered_content IngestInformation --|> FilteredContent : filtered_content IngestInformation : future_considerations IngestInformation --|> FutureContentConsiderations : future_considerations IngestInformation : included_content IngestInformation --|> IncludedContent : included_content IngestInformation : ingest_categories IngestInformation --|> IngestCategoryEnum : ingest_categories IngestInformation : relevant_files IngestInformation --|> RelevantFiles : relevant_files IngestInformation : scope IngestInformation : utility

Slots

Name	Cardinality and Range	Inheritance
ingest_categories: A term or terms indicating the type of source being ingested, from the perspective of the ingesting system (e.g. primary knowledge provider, supporting data provider, ontology/terminology provider).	* IngestCategoryEnum	direct
utility: Brief description of why the source was ingested, and the utility of the data it provides for target system use cases.	1 String	direct
scope: A short, high-level narrative describing of the types of knowledge form the source that are included and excluded in this ingest.	0..1 String	direct
relevant_files: A description of each source file (or API endpoint, database, or table) that contains content in scope for the ingest. Source files containing which content is not retrieved in this ingest need not be listed or described.	1..* RelevantFiles	direct
included_content: A description of what types of records from relevant files/endpoints/tables above are included in this ingest, and optionally a list of fields from these records that are part of the ingest or used to inform it.	* IncludedContent	direct
filtered_content: A description of what types of records from each relevant file are not included in the ingest, and the rationale for any filtering rules or exclusion criteria. Only list a file if some but not all records it contains are included in the ingest - to document what subset was excluded, and why.	* FilteredContent	direct
future_considerations: Notes about content additions or changes to consider in future iterations of this ingest. Separately consider content that will be represented as Edges vs Node Properties vs Edge Properties in the target knowledge graph.	* FutureContentConsiderations	direct
additional_notes: Additional notes, considerations or resources relevant to source content ingest, that were not otherwise captured in dedicated attributes.	0..1 String	direct

Usages

used by	used in	type	used
ReferenceIngestGuide	ingest_info	range	IngestInformation

LinkML Source

name: IngestInformation
description: A container for capturing 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
attributes:
  ingest_categories:
    name: ingest_categories
    description: A term or terms indicating the type of source being ingested, from
      the perspective of the ingesting system (e.g. primary knowledge provider, supporting
      data provider, ontology/terminology provider).
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    range: IngestCategoryEnum
    multivalued: true
  utility:
    name: utility
    description: Brief description of why the source was ingested, and the utility
      of the data it provides for target system use cases.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    range: string
    required: true
  scope:
    name: scope
    description: A short, high-level narrative describing of the types of knowledge
      form the source that are included and excluded in this ingest.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    range: string
  relevant_files:
    name: relevant_files
    description: A description of each source file (or API endpoint, database, or
      table) that contains content in scope for the ingest. Source files containing
      which content is not retrieved  in this ingest need not be listed or described.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    - FutureContentConsiderations
    range: RelevantFiles
    required: true
    multivalued: true
  included_content:
    name: included_content
    description: A description of what types of records from relevant files/endpoints/tables
      above are included in this ingest, and optionally a list of fields from these
      records that are part of the ingest or used to inform it.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    range: IncludedContent
    multivalued: true
  filtered_content:
    name: filtered_content
    description: A description of what types of records from each relevant file are
      not included in the ingest, and the rationale for any filtering rules or exclusion
      criteria. Only list a file if some but not all records it contains are included
      in the ingest - to document what subset was excluded, and why.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    range: FilteredContent
    multivalued: true
  future_considerations:
    name: future_considerations
    description: Notes about content additions or changes to consider in future iterations
      of this ingest. Separately consider content that will be represented as Edges
      vs Node Properties vs Edge Properties in the target knowledge graph.
    from_schema: https://w3id.org/biolink/resource-ingest-guide-schema
    domain_of:
    - IngestInformation
    - TargetInformation
    range: FutureContentConsiderations
    multivalued: true
  additional_notes:
    name: additional_notes
    description: Additional notes, considerations or resources relevant to source
      content ingest, 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