Slot: Data Layout (data_layout)
Data-layout object binding this sidecar to the columns of the companion data file — see envar_layout. Required: without it a consumer cannot locate the values the sidecar describes.
Tier: core
Why this slot matters
The sidecar describes values that live in a companion CSV/parquet file; without the column bindings a consumer cannot tell which column holds the values, subjects, or dates, so the metadata is unanchored and the data unusable — hence the slot is required.
In plain terms
The actual numbers live in a separate data table that travels with this record. This block is the map between the two: it names which column holds the values, which holds the person identifier, which holds the date, and so on.
URI: envar:slot/data_layout
Applicable Classes
Properties
Type and Range
Cardinality and Requirements
| Property |
Value |
| Required |
Yes |
Examples
Annotations
| property |
value |
| tier |
core |
| justification |
The sidecar describes values that live in a companion CSV/parquet file; without the column bindings a consumer cannot tell which column holds the values, subjects, or dates, so the metadata is unanchored and the data unusable — hence the slot is required. |
| explanation |
The actual numbers live in a separate data table that travels with this record. This block is the map between the two: it names which column holds the values, which holds the person identifier, which holds the date, and so on. |
| covered_by |
None |
Schema Source
Mappings
| Mapping Type |
Mapped Value |
| self |
envar:data_layout |
| native |
envar:data_layout |
LinkML Source
name: data_layout
annotations:
tier:
tag: tier
value: core
justification:
tag: justification
value: The sidecar describes values that live in a companion CSV/parquet file;
without the column bindings a consumer cannot tell which column holds the values,
subjects, or dates, so the metadata is unanchored and the data unusable — hence
the slot is required.
explanation:
tag: explanation
value: 'The actual numbers live in a separate data table that travels with this
record. This block is the map between the two: it names which column holds the
values, which holds the person identifier, which holds the date, and so on.'
covered_by:
tag: covered_by
annotations:
omop_gaia:
tag: omop_gaia
annotations:
extent:
tag: extent
value: partial
status:
tag: status
value: asserted
where:
tag: where
value: external_exposure.person_id/value_as_number + gaia_db location.csv
columns (implicit layout)
note:
tag: note
value: 'Gaia''s OMOP/gaia-db tables have value/subject/time columns but
no portable sidecar column-binding document. Conservative: partial.'
degauss:
tag: degauss
annotations:
extent:
tag: extent
value: partial
status:
tag: status
value: asserted
where:
tag: where
value: geocoded CSV columns id / lat / lon / tmax / date (implicit layout)
note:
tag: note
value: 'DeGAUSS''s CSV has value/subject/date columns but no portable
sidecar layout describing them. Conservative: partial.'
amadeus:
tag: amadeus
annotations:
extent:
tag: extent
value: partial
status:
tag: status
value: asserted
where:
tag: where
value: gridmet_tmmx.csv columns person_loc_id / lat / lon / value_kelvin
/ value_celsius (implicit layout)
note:
tag: note
value: 'Amadeus''s CSV has value/subject columns but no portable sidecar
column-binding document. Conservative: partial.'
cher:
tag: cher
annotations:
extent:
tag: extent
value: full
status:
tag: status
value: asserted
where:
tag: where
value: table_column_dictionary (column_name, description, column_tag Index/Value/Temporal/Spatial,
column_unit)
note:
tag: note
value: C-HER's column dictionary is a first-class, portable per-column
layout with a role tag and unit for every column — the closest analogue
to the sidecar's data-layout block.
codata:
tag: codata
annotations:
extent:
tag: extent
value: out_of_layer
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Companion-file column binding is instance/packaging-layer; out
of scope for CODATA.
description: 'Data-layout object binding this sidecar to the columns of the companion
data file — see envar_layout. Required: without it a consumer cannot locate the
values the sidecar describes.'
title: Data Layout
examples:
- description: abridged — see tests/data/valid/EnvironmentalExposureRecord-tmax_ideal.yaml
for a full instance
object:
table_orientation: wide
value_column: tmax
subject_column: subject_id
time_column: date
from_schema: https://w3id.org/linkml/microschemas/envar
rank: 1000
domain_of:
- EnvironmentalExposureRecord
slot_group: dataset_and_provenance
range: DataLayout
required: true
inlined: true