roundtrip_eye_bids: Execute and audit an Eye-Tracking-BIDS round trip

View source: R/055-requested-api-completion-0-7.R

roundtrip_eye_bidsR Documentation

Execute and audit an Eye-Tracking-BIDS round trip

Description

This is a callback harness so it remains stable even if the package's BIDS writer/reader signatures evolve. 'exporter' receives the source object plus 'export_args'; 'importer' receives the exporter result plus 'import_args'.

Usage

roundtrip_eye_bids(
  source,
  exporter,
  importer,
  export_args = list(),
  import_args = list(),
  extract_samples = .ep07_roundtrip_extract_samples,
  audit_args = list()
)

Arguments

source

Source eyeprocess object/table.

exporter

Function that writes/exports BIDS and returns a locator or object consumable by 'importer'.

importer

Function that reconstructs an eyeprocess object/table.

export_args, import_args

Named argument lists.

extract_samples

Function extracting the canonical sample table from source and reconstructed objects.

audit_args

Arguments forwarded to 'semantic_roundtrip_audit()'.

Value

An object of class "eye_bids_roundtrip", stored as a named list, with components "exported", "reconstructed", "audit", "status". It contains execute and audit an Eye-Tracking-BIDS round trip and associated metadata or diagnostics needed to interpret the result.


eyeprocess documentation built on Sept. 28, 2026, 5:08 p.m.

Related to roundtrip_eye_bids in eyeprocess...