Class: DataFile (DataFile)

A record representing an attached datafile.

 classDiagram
    class DataFile
    click DataFile href "../DataFile/"
      DataFile : checksum_algorithm





        DataFile --> "0..1" ChecksumAlgorithms : checksum_algorithm
        click ChecksumAlgorithms href "../ChecksumAlgorithms/"



      DataFile : compression





        DataFile --> "0..1" Compressions : compression
        click Compressions href "../Compressions/"



      DataFile : file_checksum

      DataFile : file_id

      DataFile : file_name

      DataFile : file_uuid

      DataFile : sample_id

Slots

Name	Cardinality and Range	Description	Inheritance
sample_id	1 String	The user defined sample ID used to associate samples with the sample event	direct
file_id	1 String	The unique identifier for the deposited data file	direct
file_name	1 String	The name of the files with the data for the given sample	direct
file_checksum	0..1 String	The checksum for the file	direct
checksum_algorithm	0..1 ChecksumAlgorithms	The algorithm used to calculate the file checksum	direct
compression	0..1 Compressions	The type of compression (if any) used for the file (e	direct
file_uuid	0..1 String	The UUID of the file object on the storage	direct

Identifier and Mapping Information

Schema Source

from schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema

Mappings

Mapping Type	Mapped Value
self	nfdi4immuno:DataFile
native	nfdi4immuno:DataFile

LinkML Source

Direct

name: DataFile
description: A record representing an attached datafile.
title: DataFile
from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
slots:
- sample_id
- file_id
- file_name
- file_checksum
- checksum_algorithm
- compression
- file_uuid

Induced

name: DataFile
description: A record representing an attached datafile.
title: DataFile
from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
attributes:
  sample_id:
    name: sample_id
    description: 'The user defined sample ID used to associate samples with the sample
      event. Must be unique within the study.

      '
    title: Sample ID
    examples:
    - value: MH031_v01
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    is_a: abstract_id
    identifier: true
    alias: sample_id
    owner: DataFile
    domain_of:
    - AIRRAssay
    - CytometryExperiment
    - DataFile
    - Sample
    range: string
    required: true
    pattern: ^.+$
  file_id:
    name: file_id
    description: The unique identifier for the deposited data file.
    title: The ID for the data file
    examples:
    - value: MH031_v01_f1
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    is_a: abstract_id
    identifier: true
    alias: file_id
    owner: DataFile
    domain_of:
    - DataFile
    range: string
    required: true
    pattern: ^.+$
  file_name:
    name: file_name
    description: The name of the files with the data for the given sample.
    title: File name
    examples:
    - value: MH031_v01_a.tsv
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: file_name
    owner: DataFile
    domain_of:
    - DataFile
    range: string
    required: true
    pattern: ^.+$
  file_checksum:
    name: file_checksum
    description: The checksum for the file.
    title: Checksum
    examples:
    - value: d41d8cd98f00b204e9800998ecf8427e
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: file_checksum
    owner: DataFile
    domain_of:
    - DataFile
    range: string
  checksum_algorithm:
    name: checksum_algorithm
    description: The algorithm used to calculate the file checksum.
    title: Checksum algorithm
    examples:
    - value: MD5
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: checksum_algorithm
    owner: DataFile
    domain_of:
    - DataFile
    range: ChecksumAlgorithms
  compression:
    name: compression
    description: The type of compression (if any) used for the file (e.g. zip, gz,
      bz2).
    title: Compression
    examples:
    - value: GZ
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: compression
    owner: DataFile
    domain_of:
    - DataFile
    range: Compressions
  file_uuid:
    name: file_uuid
    description: 'The UUID of the file object on the storage. This field has no  reason
      to be visible to the user.

      '
    title: The UUID of the file object on the storage
    examples:
    - value: 9f3a8b7e-8618-4a19-bb4c-38a087ad8c17
      description: Example UUID v4 for internal file storage reference.
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: file_uuid
    owner: DataFile
    domain_of:
    - DataFile
    range: string