Skip to content

Commit 5ecaec1

Browse files
authored
Enhance age dataset documentation (#669)
1 parent 1cbd9a8 commit 5ecaec1

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

core/nwb.file.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,12 @@ groups:
415415
datasets:
416416
- name: age
417417
dtype: text
418-
doc: Age of subject. Can be supplied instead of 'date_of_birth'.
418+
doc: "Age of subject. Can be supplied instead of 'date_of_birth'.
419+
The ISO 8601 Duration format is recommended, e.g., 'P90D' for 90 days old.
420+
If the precise age is unknown, an age range can be given by '[lower bound]/[upper bound]' e.g.
421+
'P10D/P20D' would mean that the age is in between 10 and 20 days. If only the lower bound is known,
422+
then including only the slash after that lower bound can be used to indicate a missing bound.
423+
For instance, 'P90Y/' would indicate that the age is 90 years or older."
419424
quantity: '?'
420425
attributes:
421426
- name: reference

docs/format/source/format_release_notes.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Minor changes
1212
that are typically used together for analysis, such as spike sorting. (#659)
1313
- Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``)
1414
should be in microns. (#658)
15+
- Expanded documentation for the ``Subject`` 'age' dataset, including details on ISO 8601 Duration format and
16+
age range representation.
1517

1618

1719
2.9.0 (June 26, 2025)

0 commit comments

Comments
 (0)