Class: AutomatedAnnotation

A set of fields for recording the details of the automated annotation algorithm used. (Common 'automated annotation methods' would include PopV, Azimuth, CellTypist, scArches, etc.)

URI: cell_annotation_schema:AutomatedAnnotation

classDiagram class AutomatedAnnotation click AutomatedAnnotation href "../AutomatedAnnotation" AutomatedAnnotation : algorithm_name AutomatedAnnotation : algorithm_repo_url AutomatedAnnotation : algorithm_version AutomatedAnnotation : reference_location

Slots

Name	Cardinality and Range	Description	Inheritance
algorithm_name	1 String	The name of the algorithm used	direct
algorithm_version	1 String	The version of the algorithm used (if applicable)	direct
algorithm_repo_url	1 String	This field denotes the URL of the version control repository associated with ...	direct
reference_location	0..1 String	This field denotes a valid URL of the annotated dataset that was the source o...	direct

Usages

used by	used in	type	used
Labelset	automated_annotation	range	AutomatedAnnotation

Identifier and Mapping Information

Schema Source

from schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS

Mappings

Mapping Type	Mapped Value
self	cell_annotation_schema:AutomatedAnnotation
native	cell_annotation_schema:AutomatedAnnotation

LinkML Source

Direct

name: AutomatedAnnotation
description: A set of fields for recording the details of the automated annotation
  algorithm used. (Common 'automated annotation methods' would include PopV, Azimuth,
  CellTypist, scArches, etc.)
from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
slots:
- algorithm_name
- algorithm_version
- algorithm_repo_url
- reference_location

Induced

name: AutomatedAnnotation
description: A set of fields for recording the details of the automated annotation
  algorithm used. (Common 'automated annotation methods' would include PopV, Azimuth,
  CellTypist, scArches, etc.)
from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
attributes:
  algorithm_name:
    name: algorithm_name
    description: The name of the algorithm used. It MUST be a string of the algorithm's
      name.
    from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
    rank: 1000
    alias: algorithm_name
    owner: AutomatedAnnotation
    domain_of:
    - AutomatedAnnotation
    range: string
    required: true
  algorithm_version:
    name: algorithm_version
    description: The version of the algorithm used (if applicable). It MUST be a string
      of the algorithm's version, which is typically in the format '[MAJOR].[MINOR]',
      but other versioning systems are permitted (based on the algorithm's versioning).
    from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
    rank: 1000
    alias: algorithm_version
    owner: AutomatedAnnotation
    domain_of:
    - AutomatedAnnotation
    range: string
    required: true
  algorithm_repo_url:
    name: algorithm_repo_url
    description: This field denotes the URL of the version control repository associated
      with the algorithm used (if applicable). It MUST be a string of a valid URL.
    from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
    rank: 1000
    alias: algorithm_repo_url
    owner: AutomatedAnnotation
    domain_of:
    - AutomatedAnnotation
    range: string
    required: true
  reference_location:
    name: reference_location
    description: "This field denotes a valid URL of the annotated dataset that was\
      \ the source of annotated reference data. \nThis MUST be a string of a valid\
      \ URL. The concept of a 'reference' specifically refers to 'annotation transfer'\
      \ algorithms, whereby a 'reference' dataset is used to transfer cell annotations\
      \ to the 'query' dataset."
    from_schema: https://cellular-semantics.sanger.ac.uk/ontology/CAS
    rank: 1000
    alias: reference_location
    owner: AutomatedAnnotation
    domain_of:
    - AutomatedAnnotation
    range: string