Skip to content

Conversation

@mszinte
Copy link
Contributor

@mszinte mszinte commented Jun 15, 2022

Important

This BEP is under community review from September 29 - October 10, 2025. Please participate at #2218.

Here is the specifications of the BEP 020 about eye tracking.

  • it follows the main discussion initiated on a google document.
  • it includes the different modification the group of maintainers suggested to us during our zoom meeting.
  • it includes the macros as used in other modality specific extensions
  • it includes links toward dataset examples.

Note

We meet regularly and everyone is welcome :
Next meeting April 3rd 2025 4pm UTC (EST 11am, PST 8am, CET 5pm, GMT 4pm) on zoom.

Note that if you consider joining but this time or day doesn't suits you, reach me (@mszinte) and I will arrange another appointment.

Notes of last meeting

Chat and discussions also happening on matrix

We are currently drafing a companion paper for this BEP, feel free to participate (GoogleDoc)

Issues for:


  • implement macros
    • for filename templates ?
    • for examples ?
    • for metadata table
  • add contributors to the wiki (so they can be added to the contributors page)
  • end docmentation
  • update examples
  • update validator
  • update list of contributors via the github wiki

@mszinte mszinte requested a review from tsalo as a code owner June 15, 2022 12:09
correction of text
@sappelhoff sappelhoff added the BEP label Jul 12, 2022
@sappelhoff
Copy link
Member

(NOTE: I'll cross-post this message across several BEP threads)

Hi there, just a quick notification that we have just merged #918 and it may be interesting to look at the implications for this BEP.

We are introducing "BIDS URIs", which unify the way we refer to and point to files in BIDS datasets (as opposed to "dataset-relative" or "subject-relative" or "file-relative" links).

If the diff and discussion in the PR is unclear, you can also read the rendered version: https://bids-specification.readthedocs.io/en/latest/02-common-principles.html#bids-uri

Perhaps there are things in the BEP that need adjusting now, but perhaps also not -- in any case it's good to be aware of this new feature!

Let me know if there are any questions, comments, or concerns.

@tsalo tsalo changed the title [ENH] Bep020 [ENH] BEP 020 Eye Tracking Aug 24, 2022
Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following Yarik's comments, I had a closer look at the metadata.

@mszinte @oesteban @julia-pfarr @DejanDraschkow could you please have a look? I'm happy to help with the schema, but I don't know what the target is.

@effigies effigies dismissed stale reviews from yarikoptic, julia-pfarr, and themself January 12, 2026 16:41

All suggestions applied.

mszinte and others added 2 commits January 13, 2026 10:13
…hese parameters

Removed ScreenAOIDefinition from physiological recordings.
Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is ready to go, pending @julia-pfarr's sign off on examples in bids-standard/bids-examples#514.

@julia-pfarr
Copy link
Member

I believe this is ready to go, pending @julia-pfarr's sign off on examples in bids-standard/bids-examples#514.

Yes, I'll take care of that on Friday like discussed in our meeting on Monday!

Remove trailing commas before closing braces/brackets which are
invalid in JSON (valid in JavaScript but not JSON).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <[email protected]>
@julia-pfarr
Copy link
Member

@bids-maintenance could we get another approval on this PR? I can't due to conflict of interest

@effigies
Copy link
Collaborator

I haven't generally demanded a second green check on BEPs; there's been community review. The 2 review thing is generally to make sure that normal PRs have some level of buy-in from interested parties, and they can come from any community member.

So, invoking rule 5:

  1. A Maintainer can merge any PR - even if it's not eligible to merge according to Rule 4.

Let's merge!

@effigies effigies merged commit a87f131 into bids-standard:master Jan 16, 2026
27 checks passed
effigies added a commit to bids-standard/bids-examples that referenced this pull request Jan 16, 2026
* enh: add first dataset (ds004158)

Complements: bids-standard/bids-specification#1128.

* enh: add second dataset (natImSac)

Complements: bids-standard/bids-specification#1128

* enh: leave only two participants per example

* fix: point schema to BEP020's version

* modify examples according to new BEP020 updates

* resolve validator issues

* fix participants.tsv

* chore: Skip eyetracking on older validators

* Fix JSON schema complaints

* Fix JSON schema complaints

* Add gzip headers to tsv.gz files

* chore(ci): Install BEP020 branch of validator

* add missing ScreenOrigin

* change openneuro reference

* Apply suggestions from code review

Co-authored-by: Chris Markiewicz <[email protected]>

* correct screen distance and delete EnvironmentCoordinates

* Revert to using the dev version of the validator

* change StartTime and delete StopTime

* fix StartTime

* Update .github/workflows/validate_datasets.yml

---------

Co-authored-by: Oscar Esteban <[email protected]>
Co-authored-by: Christopher J. Markiewicz <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
@effigies effigies changed the title [ENH] BEP 020 Eye Tracking [ENH] BEP 020 - Eye Tracking Jan 16, 2026
@effigies effigies changed the title [ENH] BEP 020 - Eye Tracking [ENH] BEP020 - Eye Tracking Jan 16, 2026
ericearl added a commit to surchs/bids-specification that referenced this pull request Jan 21, 2026
* BEP 042: Electromyography (EMG)

Co-authored-by: Seyed (Yahya) Shirazi <[email protected]>
Co-authored-by: Jörn M. Horschig <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* formatting: remove equals sign from definitions

* clarify: no quotes for description column values

* add Preamplification and Gain as recommended fields to emg.json

* clarify: where to specify IED and ElectrodeMaterial in different scenarios

* harmonize LATENCY definition with BIDS-Motion

* add passage about multi-modal synchronization

* fmt: remark (space between list items); runprettier

* better validation (and comments)

* Updated HED Version in spec to 8.4.0

* Update src/appendices/hed.md

Co-authored-by: Seyed (Yahya) Shirazi <[email protected]>

* fix: Get TSV tables rendering again (bids-standard#2248)

* sty: Address ruff complaints

* fix: Move sidecar constraint into sidecar section

* add units

* make preamp and gain optional

* [FIX] Allowing to render JSON null type (bids-standard#2265)

* Allowing to render JSON null type with a link

* Python style

* fix: Add type annotations, fix a bug in loading schema path (bids-standard#2264)

* type: Annotate bst.utils

* type: Annotate types.namespace

* type: Annotate bst.schema

* chore: Update pre-commit hooks

* chore: Bump schema package to 1.1.3

* chore: Bump schema package to 1.1.4-dev

* chore: Fix Python formatting

* chore(deps): bump glob from 10.4.5 to 10.5.0 (bids-standard#2266)

Bumps [glob](https://github.com/isaacs/node-glob) from 10.4.5 to 10.5.0.
- [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md)
- [Commits](isaacs/node-glob@v10.4.5...v10.5.0)

---
updated-dependencies:
- dependency-name: glob
  dependency-version: 10.5.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Adding bclenet as maintainer (bids-standard#2259)

* add EMG channel count rule

* tweak sidecar REQ/REC/OPT

* DRY

* make it required

* remove dB unit

* move corresponding narrative chunk from recommended to required section

* remove outdated TODOs

* Update events.md (bids-standard#2268)

Noticed a typo when reading the spec

* chore: Install maintenance tools for publish_schema

* chore: Add dependabot for jsr-maint branch, set cooldown

* chore: Setup node to avoid thrashing lockfile

* chore: Setup node after switching to JSR branch

* fix: Correct typos and formatting in specification documents (bids-standard#2253)

Fixed several language and formatting errors discovered during comprehensive
proofing of specification files using the proof-spec skill:

In src/common-principles.md:
- Line 18: Fixed duplicated "be" in "cannot be be interpreted"
- Line 96: Changed "unapplicable" to correct form "inapplicable"
- Line 634: Removed duplicated "files" in "files files MUST NOT"
- Line 1070: Fixed duplicated "is" to "it is RECOMMENDED"

In src/CHANGES.md:
- Line 80: Wrapped literal URL in angle brackets per markdown style guide
  (remark-lint: no-literal-urls rule)

In src/appendices/meg-systems.md:
- Line 17: Fixed broken table separator with space in middle
- Auto-formatted table for consistency

In src/schema/objects/entities.yaml:
- Line 153: Fixed missing closing quote in "InversionTime" metadata field reference

In src/schema/rules/checks/deprecations.yml:
- Line 1: Added missing YAML document start marker (---) to resolve yamllint warning

All fixes improve readability and correctness of the specification without
changing any technical requirements or meaning.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <[email protected]>

* [pre-commit.ci] pre-commit autoupdate (bids-standard#2270)

updates:
- [github.com/pre-commit/mirrors-mypy: v1.18.2 → v1.19.0](pre-commit/mirrors-mypy@v1.18.2...v1.19.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: Add "serve" rule to Makefile and provide description to what actions are available

by default make does nothing!  I kept it that way but made that "nothing" explicit.
I also added serve target so it is straightforward to trigger build&serve

* Apply suggestions from code review

* Update src/schema/rules/json/emg.yaml

* Update src/modality-specific-files/electromyography.md

* fix: Pacify YAML linter

* Update Makefile

Co-authored-by: Copilot <[email protected]>

* Update CONTRIBUTING.md

Co-authored-by: Copilot <[email protected]>

* feat(bst): Defer type imports (bids-standard#2269)

* feat: Add _lazytypes

* rf: Move version loading into submodule

* type: Use lazytypes throughout

* chore: Add type checking dependency group

* type: Improve type annotations for __main__

* [DATALAD RUNCMD] uv lock

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uv lock",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [
  "pyproject.toml",
  "tools/schemacode/pyproject.toml",
  "uv.lock"
 ],
 "outputs": [
  "uv.lock"
 ],
 "pwd": "."
}
^^^ Do not change lines above ^^^

* chore: Use Python 3.13 to build docs

* chore(deps): bump the actions-infrastructure group with 3 updates (bids-standard#2244)

Bumps the actions-infrastructure group with 3 updates: [actions/download-artifact](https://github.com/actions/download-artifact), [actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/setup-node](https://github.com/actions/setup-node).


Updates `actions/download-artifact` from 5 to 6
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v5...v6)

Updates `actions/upload-artifact` from 4 to 5
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v4...v5)

Updates `actions/setup-node` from 5 to 6
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v5...v6)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/upload-artifact
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/setup-node
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: Ignore jsr.io in link checks

* chore: Ignore redirect warnings in link checks

Add --no-warnings flag to linkchecker commands to prevent CI failures
on HTTP redirect warnings (301/302/303), which are valid links.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>

* test(bst): Narrow glossary validation test (bids-standard#2284)

* Fix rule dependency for serve + separate sentences to be on sep lines

Co-authored-by: Chris Markiewicz <[email protected]>

* chore: Bump schema package to 1.1.4

* chore: Bump schema package to 1.1.5-dev

* chore(ci): Avoid modifying package-lock.json

* chore: Teach ruff that _lazytypes is like typing

* [DATALAD RUNCMD] uvx ruff check --fix

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uvx ruff check --fix",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

* chore(deps): bump the node-utilities group with 2 updates (bids-standard#2292)

Bumps the node-utilities group with 2 updates: [remark-lint-no-trailing-spaces](https://github.com/Trott/remark-lint-no-trailing-spaces) and [prettier](https://github.com/prettier/prettier).


Updates `remark-lint-no-trailing-spaces` from 3.0.2 to 4.0.3
- [Release notes](https://github.com/Trott/remark-lint-no-trailing-spaces/releases)
- [Commits](Trott/remark-lint-no-trailing-spaces@v3.0.2...v4.0.3)

Updates `prettier` from 3.6.2 to 3.7.4
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/prettier@3.6.2...3.7.4)

---
updated-dependencies:
- dependency-name: remark-lint-no-trailing-spaces
  dependency-version: 4.0.3
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: node-utilities
- dependency-name: prettier
  dependency-version: 3.7.4
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: node-utilities
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump the actions-infrastructure group with 3 updates (bids-standard#2291)

Bumps the actions-infrastructure group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [actions/download-artifact](https://github.com/actions/download-artifact) and [actions/upload-artifact](https://github.com/actions/upload-artifact).


Updates `actions/checkout` from 5 to 6
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v5...v6)

Updates `actions/download-artifact` from 6 to 7
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v6...v7)

Updates `actions/upload-artifact` from 5 to 6
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/download-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/upload-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* BEP-038: Atlases (bids-standard#1714)

Co-authored-by: melanieganz <[email protected]>
Co-authored-by: PeerHerholz <[email protected]>
Co-authored-by: Cyril Pernet <[email protected]>
Co-authored-by: Oscar Esteban <[email protected]>
Co-authored-by: James Kent <[email protected]>
Co-authored-by: melanieganz <[email protected]>
Co-authored-by: Paul Wighton <[email protected]>
Co-authored-by: mnoergaard <[email protected]>
Co-authored-by: Taylor Salo <[email protected]>
Co-authored-by: Mathieu Guay-Paquet <[email protected]>
Co-authored-by: Mark Mikkelsen <[email protected]>
Co-authored-by: Yaroslav Halchenko <[email protected]>

* [ENH] Make Pharmaceutical metadata terms less PET-specific (bids-standard#2294)

* RF: PharmaceuticalDoseAmount - shift mentioning of a "tracer" into PET use

We are to introduce use of Pharma* fields into BEP032 where it has no notion of tracers.
I am moving this extra description to become PET specific, but also PET people might want
to double check if that is what was actually intended (or it could be administered separate
from the tracer

* Fix DICOM tag for Intervention Drug Dose

Co-authored-by: Chris Markiewicz <[email protected]>

* fix: use 0018 not 0008 section for Drug DICOM fields and format consistently with others and hyperlink

* Also move "tracer" mentioning into addendum for PharmaceuticalName

---------

Co-authored-by: Chris Markiewicz <[email protected]>

* type: Avoid breaking third-party autodoc generation (bids-standard#2303)

* type: Avoid breaking third-party autodoc generation

* chore: ruff check --fix

* chore: Recognize _laztypes as typing, for linting purposes

* chore: Bump schema package to 1.1.5

* chore: Bump schema package to 1.1.6-dev

* [pre-commit.ci] pre-commit autoupdate (bids-standard#2280)

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.35.0 → 0.36.0](python-jsonschema/check-jsonschema@0.35.0...0.36.0)
- [github.com/pre-commit/mirrors-mypy: v1.19.0 → v1.19.1](pre-commit/mirrors-mypy@v1.19.0...v1.19.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [ENH] BEP 020 Eye Tracking (bids-standard#1128)

* minor update md

* final changes and working version with mkdocs

* add forgotten example

* final changes

* latest changes

* Update 10-eye-tracking.md

correction of text

* Apply suggestions from code review

* fix bad latin

* md lint

* fix yml

* md lint

* lint yml

* add semantic line breaks

* move suffix

* rm CogPOID and CogAtlas yml

* move some metadata

* move more metadata

* move more metadata

* rely on task.yml for events

* change extension to tsv

* fix schema

* fix links

* fix typos

* fix link

* most of the change but mkserve not working yet

* some more change still not working

* change in mkdocs.yml based on commments

* run pre-commit and fix yml

* add eyetrack modality object

* format markdown

* format markdown

* space missing in tabular_data/eyetrack.yaml

* fixing conflict for real

* automatic changes by pre-commit

* instru

* pre-commit stuff

* correct error of manipulation of logo.eps

* some test

* some test

* some test

* some test

* changes of columns names

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Taylor Salo <[email protected]>

* change in metadata

* test new changes with pre-commit

* correct error in eyetrack.md

* add RecordTimeStart and RecordTimeEnd

* cahnge eye_sample to eye_timestamp

* correct error example json

* error in datasets links

* last round of review on main doc

* slight modif of SAOI

* slight modif of main md

* correction of space

* try without modality

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Yaroslav Halchenko <[email protected]>

* put back mkdocs.yaml with unsorted modality specific files

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Taylor Salo <[email protected]>

* Update src/schema/objects/metadata.yaml

Co-authored-by: Taylor Salo <[email protected]>

* Update src/schema/objects/metadata.yaml

Co-authored-by: Taylor Salo <[email protected]>

* Update src/schema/objects/metadata.yaml

Co-authored-by: Taylor Salo <[email protected]>

* change after review of tsalo

* put back /tool/filetree_exampl.ipynb

* instru

* change on metadata based on tsalo comments

* change to desambiguate the columns in case of two eyes recording

* change to account for the BEP020

* change of json example in reply to https://github.com/bids-standard/bids-specification/pull/1128/files/9f223a1488ed1ac844f1bfd63ffd93af696102fd#r1047302456

* change RecordTimeStart and RecordTimeEnd to StartTime_eyetrack (with same name as StartTime physio) and StopTime_eyetrack

* take out Scree settings from metadata as they were put in the main branch of bids specification

* insist on calibration in the text

* add eyetrack suffix to timeseries suffixes in task.yaml in order to add eyetrack files to other modality automatically by macros

* point 2 on suggestion bids-standard#1128 (comment)

* fix markdown

* fix markdown

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* codespell fixes

* schema fix

* change to follow recommandations of https://doi.org/10.3758/s13428-021-01762-8

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* split metadata

* fix metadata

* format

* fix typo

* update example

* make gunzip optional

* add required events.json metadata

* fix list

* fix list

* Update eye-tracking.md

Change link to new version of resting state dataset on openneuro

* Changes for metadata

- change DataType from number to array of arrays for AverageCalibrationError and MaximalCalibrationError
- delete CalibrationList from metadata.yaml and eyetrack.yaml as it only contains dublicates of other metadata and thus not needed
- fix typo in metadata.yaml: CalibrationCount was wrongly named "CalibrationType" so CalibrationType was listed twice

* change unit of ScreenSize in example events.json

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Arshitha Basavaraj <[email protected]>

* Apply suggestions from code review

Co-authored-by: Oscar Esteban <[email protected]>

* Update src/schema/objects/columns.yaml

Co-authored-by: Oscar Esteban <[email protected]>

* Update src/schema/objects/columns.yaml

Co-authored-by: Oscar Esteban <[email protected]>

* Update metadata.yaml

Attempt to fix the type of AverageCalibrationError and MaximalCalibrationError, leaving empty the number of maxItems as it is possible to have as many calibration as desired

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/schema/objects/metadata.yaml

* fix issues in mkdocs.yml

* hasty copy paste

* fix time stamp

* add placeholder for eventual publication

* Update metadata.yaml

Add description for two eyes.

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Oscar Esteban <[email protected]>

* Update src/modality-specific-files/eye-tracking.md

Co-authored-by: Oscar Esteban <[email protected]>

* Update src/modality-specific-files/near-infrared-spectroscopy.md

Co-authored-by: Oscar Esteban <[email protected]>

* enh: a proposal for the new ``RecordingType`` (-> ``PhysioType``) idea

* enh: add eyetracking examples

* enh: revise metadata specifications

* fix: remove duplicated metadata entry

* restore eyetrack sidecars

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: pacify codespell

* fix: pacify markdown linter

* fix: attempt to get line numbers on tsv files

* fix: attempt 2 to get line numbers on tsv files

* Update src/modality-specific-files/eye-tracking.md

* fix: address several issues, add example datasets, pacify remark

* enh: better ordering, clearer definitions

* sty: pacify remark

* enh: change zero-based to one-base indexes, more consistent with BIDS

* fix: remove redirected URL

* enh: add columns definition for physioevents and improve eyetracker examples

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: length of new message column description

* fix: improved definition of ForeignIndexColumn

* enh: clearly state specific physio types at the outset

* enh: improving and adding example file trees

* fix: normalize file tree macros and repare syntax of some

* fix: typos and readability improvements

* review and slight text modification

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: revert boilerplate about publication

* enh: drop "old" eyetrack

* fix: ``"cyclopean"`` value for ``RecordedEye`` metadata

* fix: deduplicate example datasets, and move eyetrack's ones into an admonition at the beginning of its section

* fix: missing setting eyetrack tabular data allowed to add columns

* enh: deep reorganization of the section

* fix: pacify linter

* Update src/modality-specific-files/physiological-and-other-continuous-recordings.md

Co-authored-by: Remi Gau <[email protected]>

* enh: move escalating events' metadata to REQUIRED into task data section

* fix unit

* use levels to describe metadata

* fix typo

* minor schema fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix

* enh: add @Sourav-Kulkarni's suggestions about eye-tracker/screen distance

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* enh: address @qian-chu's review comment about documenting timestamp

* enh: address @Remi-Gau's comment on column order

* Update src/modality-specific-files/physiological-recordings.md

* Update src/modality-specific-files/physiological-recordings.md

Co-authored-by: Scott Huberty <[email protected]>

* Update src/modality-specific-files/physiological-recordings.md

Co-authored-by: Scott Huberty <[email protected]>

* fix: address issue of ``EnvironmentCoordinates``

* enh: add note about the type of pupil size being recorded

Reference: https://github.com/bids-standard/bids-specification/pull/1128/files#r1916646141

* enh: document all four columns of physio.json file

* Update src/schema/objects/metadata.yaml

* fix: remove backtick breaking yaml file

* Update physiological-recordings.md to change the BIDS example

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update metadata.yaml 

Changing AverageCalibrationError and MaximalCalibrationError to use the term "degrees of visual angle" rather than "degrees" and "visual degrees".

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update metadata.yaml

Change EyeTrackingMethod to get rid of the citation of a retracted paper.

* fix: implement association for StimulusPresentation mutation

* fix: bad merge from upstream/master

* fix: potential conflict created by `SampleCoordinatesUnits`

Resolves: https://github.com/bids-standard/bids-specification/pull/1128/files#r1712953676

cc: @Remi-Gau

* fix: onset definition of physioevents should allow units other than s

Resolves: https://github.com/bids-standard/bids-specification/pull/1128/files#r1693909512

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: convert `SampleCoordinateSystem` into an enum

* fix: remove old leftover in AverageCalibrationError

* Update src/modality-specific-files/physiological-recordings.md

Co-authored-by: Chris Markiewicz <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Markiewicz <[email protected]>

* fix(schema): Make StimulusPresentation__eyetrack

* Apply suggestions from code review

Co-authored-by: Chris Markiewicz <[email protected]>

* fix: onset__physioevents; make timestamp required

* fix: Remove ForeignIndexColumn

* Revert "fix: Remove ForeignIndexColumn"

This reverts commit f5b123d.

* fix: tables

* Update src/modality-specific-files/physiological-recordings.md

* fix: Broken link

* fix(schema): Quote valid YAML expression, expect strings in selectors

* fix: Physio files do not inherit

* Make ForeignIndexColumn required, simplify section by placing timestamp first

* Fix style complaint

* chore: Add associations.events.sidecar, remove task selector

* feat(schema): Make assertions on physio, not events

* Remove associations.physio

* Revert "Remove associations.physio"

This reverts commit 8c97ae1.

* fix(schema): Extension is a string

* feat: Add ForeignIndexColumn consistency check

* fix: Remove bad selector

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Julia-Katharina Pfarr <[email protected]>

* Limit screen requirements to gaze-on-screen

* Update src/schema/objects/metadata.yaml

Co-authored-by: Yaroslav Halchenko <[email protected]>

* Account for n/a values in StimulusPresentation

* fix: Clarify pupil size can be diameter, add check for description

* test: Allow sidecar expressions to include known column names

* fix: Restrict eye-tracking column requirements to physio files

* Update src/schema/objects/metadata.yaml

Co-authored-by: Oscar Esteban <[email protected]>

* Update src/schema/objects/metadata.yaml

* Apply suggestions from code review

* Update src/modality-specific-files/physiological-recordings.md

* Remove ScreenAOIDefinition field in agreement with getting rid with these parameters

Removed ScreenAOIDefinition from physiological recordings.

* Demote non-essential fields to optional

* Fix invalid JSON in eye-tracking physioevents example (bids-standard#13)

Remove trailing commas before closing braces/brackets which are
invalid in JSON (valid in JavaScript but not JSON).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.5 <[email protected]>

---------

Co-authored-by: Klara Gregorova <[email protected]>
Co-authored-by: mszinte <[email protected]>
Co-authored-by: Remi Gau <[email protected]>
Co-authored-by: mszinte <[email protected]>
Co-authored-by: Taylor Salo <[email protected]>
Co-authored-by: Yaroslav Halchenko <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: julia-pfarr <[email protected]>
Co-authored-by: julia-pfarr <[email protected]>
Co-authored-by: Arshitha Basavaraj <[email protected]>
Co-authored-by: Oscar Esteban <[email protected]>
Co-authored-by: Stefan Appelhoff <[email protected]>
Co-authored-by: Scott Huberty <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Ross Blair <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Claude Opus 4.5 <[email protected]>

* Add table for DWI recommended metadata (bids-standard#2308)

* [pre-commit.ci] pre-commit autoupdate (bids-standard#2314)

updates:
- [github.com/adrienverge/yamllint: v1.37.1 → v1.38.0](adrienverge/yamllint@v1.37.1...v1.38.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* fix: correct schema file path in eye tracking documentation comment (bids-standard#2316)

The comment incorrectly referenced eyetrack.yaml when the actual
schema file is physio.yaml (as correctly used in the macro call).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Sonnet 4.5 <[email protected]>

* [Schema][Fix] add checks for multiple frame consistency issues  (bids-standard#2310)

* add checks for multiple frame consistency issues

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* keeping me honest yamllint

* remove redundant selector ||

* remove redundant check

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Daniel McCloy <[email protected]>
Co-authored-by: Seyed (Yahya) Shirazi <[email protected]>
Co-authored-by: Jörn M. Horschig <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kay Robbins <[email protected]>
Co-authored-by: Chris Markiewicz <[email protected]>
Co-authored-by: Boris Clénet <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Teon L Brooks <[email protected]>
Co-authored-by: Yaroslav Halchenko <[email protected]>
Co-authored-by: Claude <[email protected]>
Co-authored-by: Ross Blair <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: melanieganz <[email protected]>
Co-authored-by: PeerHerholz <[email protected]>
Co-authored-by: Cyril Pernet <[email protected]>
Co-authored-by: Oscar Esteban <[email protected]>
Co-authored-by: James Kent <[email protected]>
Co-authored-by: melanieganz <[email protected]>
Co-authored-by: Paul Wighton <[email protected]>
Co-authored-by: mnoergaard <[email protected]>
Co-authored-by: Taylor Salo <[email protected]>
Co-authored-by: Mathieu Guay-Paquet <[email protected]>
Co-authored-by: Mark Mikkelsen <[email protected]>
Co-authored-by: Martin Szinte <[email protected]>
Co-authored-by: Klara Gregorova <[email protected]>
Co-authored-by: mszinte <[email protected]>
Co-authored-by: Remi Gau <[email protected]>
Co-authored-by: mszinte <[email protected]>
Co-authored-by: Taylor Salo <[email protected]>
Co-authored-by: julia-pfarr <[email protected]>
Co-authored-by: julia-pfarr <[email protected]>
Co-authored-by: Arshitha Basavaraj <[email protected]>
Co-authored-by: Stefan Appelhoff <[email protected]>
Co-authored-by: Scott Huberty <[email protected]>
Co-authored-by: Kabilar Gunalan <[email protected]>
Co-authored-by: Anthony Galassi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BEP eye-tracking physio Proposed BEP see https://bids.neuroimaging.io/collaboration/governance.html#proposed-bep

Projects

None yet

Development

Successfully merging this pull request may close these issues.