Declare a vendor semantic schema contract

Usage

vendor_schema_contract(
  vendor,
  version = NA_character_,
  required_fields = character(),
  optional_fields = character(),
  aliases = list(),
  timestamp = list(),
  coordinate = list(),
  units = list(),
  eye_streams = character(),
  event_fields = character()
)

Arguments

vendor: Vendor/ecosystem label.
version: Optional format/software version.
required_fields: Fields that must survive import.
optional_fields: Fields that may be present.
aliases: Named list mapping canonical fields to accepted vendor names.
timestamp: Named list describing device/system/media time columns.
coordinate: Named list describing x/y columns and coordinate semantics.
units: Named list of expected units for canonical fields.
eye_streams: Expected eye streams (`left`, `right`, `cyclopean`, etc.).
event_fields: Event/annotation fields expected to survive.

Value

An object of class "eye_vendor_schema_contract", stored as a named list, with components "vendor", "version", "required_fields", "optional_fields", "aliases", "timestamp", "coordinate", "units", "eye_streams", "event_fields", "contract_version". It contains declare a vendor semantic schema contract and associated metadata or diagnostics needed to interpret the result.