Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADD] describing fields in event.json file #1255

Merged
merged 13 commits into from
May 28, 2024
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion mne_bids/write.py
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,28 @@ def _events_json(fname, overwrite=False):
Whether to overwrite the output file if it exists.
"""
new_data = {
"sample": {"Description": "The event onset time in number of sampling points."},
"onset": {
"Requirement Level": "REQUIRED",
"Data type": "number",
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
"Description": (
"Onset (in seconds) of the event from the beginning of the first data"
"point. Negative onsets account for events before the first stored "
"data point."
),
},
"duration": {
"Requirement Level": "REQUIRED",
"Data type": "number or 'n/a'",
"Description": (
"Duration of the event in seconds from onset. "
"Must be zero, positive, or 'n/a' if unavailable. "
"A zero value indicates an impulse event. "
),
},
"sample": {
"Data type": "number",
"Description": ("The event onset time in number of sampling points."),
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
},
"value": {
"Description": (
"The event code (also known as trigger code or event ID) "
Expand Down
Loading