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

[ENH] Schema changes related to BEP032 #1826

Open
wants to merge 33 commits into
base: bep032
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
1b7234f
[FIX] Minor YAML formatting
ree-gupta May 17, 2024
47c2a03
[ENH] Added additional birthdate column for participants.tsv
ree-gupta May 17, 2024
cfc163e
[ENH] Added age_category, age_type and corresponding enums
ree-gupta May 17, 2024
b9894f5
[ENH] Added surgery_date column
ree-gupta May 17, 2024
414f272
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 17, 2024
3833e28
Reverted changes that better suit in a PR against master
ree-gupta May 27, 2024
7079c18
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 27, 2024
11bffa0
[ENH] Added tabular_data file and columns for _probes.tsv
ree-gupta May 27, 2024
ab66a63
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 27, 2024
b3c2b43
[ENH] Added tabular_data rules and columns for _electrodes.tsv
ree-gupta May 27, 2024
2e7fd70
Merge branch 'bep032' of https://github.com/ree-gupta/bids-specificat…
ree-gupta May 27, 2024
29704ce
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 27, 2024
73e600e
[ENH] Added tabular_data rules for _electrodes.tsv
ree-gupta May 27, 2024
e67f946
[ENH] Added tabular_data rules and columns for _channels.tsv
ree-gupta May 27, 2024
1622986
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 27, 2024
749a7c9
[FIX] Fixed pre-commit errors
ree-gupta Jun 18, 2024
329b1e2
[ENH] Added additional ephys columns for events.tsv
ree-gupta Jun 18, 2024
8a0df20
[ENH] Added tabular data rules for events.tsv to include ephys relate…
ree-gupta Jun 18, 2024
8caaaf2
[ENH] Added metadata entities for ephys setup metadata
ree-gupta Jun 18, 2024
0b75398
[ENH] Created sidecar rule file for ephys metadata and added data ori…
ree-gupta Jun 18, 2024
9400f4f
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Jul 16, 2024
3626004
Made schema changes to match microephys data type
ree-gupta Jul 17, 2024
2ff94e0
Renamed rule files from ephys to microephys
ree-gupta Jul 17, 2024
1a1d3c6
Made schema changes to match microephys data type
ree-gupta Jul 17, 2024
30974f8
[ENH] Added objects and rules for coordinate system sidecar file
ree-gupta Jul 17, 2024
f524dfe
[ENH] Added processing microephys metadata field in rules
ree-gupta Jul 17, 2024
686b559
[ENH] Added pharmaceuticals microephys metadata field in rules
ree-gupta Jul 17, 2024
c9e2eb3
[ENH] Added supplementary microephys metadata field and rules
ree-gupta Jul 17, 2024
c2a251a
[ENH] Added sample microephys metadata rules
ree-gupta Jul 17, 2024
c130ad5
[ENH] Added task microephys metadata rules
ree-gupta Jul 17, 2024
8c658b8
Fixed example language convention
ree-gupta Sep 18, 2024
fe441bc
Added microephys in schema rule modality
ree-gupta Sep 18, 2024
f825531
Corrected SampleThickness to SliceThickness
ree-gupta Sep 18, 2024
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
45 changes: 37 additions & 8 deletions src/schema/objects/columns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,29 @@ age:
for privacy purposes.
type: number
unit: year
age_category:
name: age_category
display_name: Age category
description: |
For non-numeric description of the age (e.g. developmental stage) a string can be provided.
We RECOMMEND to use the [UBERON life cycle stage](http://purl.obolibrary.org/obo/UBERON_0000105) to specify it.
type: string
age_type:
name: age_type
display_name: Age type
description: |
Type of age measurement (e.g. `postnatal`, `fetal`, `gestational`). If not specified, `postnatal` is assumed.
type: string
enum:
- $ref: objects.enums.postnatal.value
- $ref: objects.enums.fetal.value
- $ref: objects.enums.gestational.value
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you @ree-gupta ! I wonder if we better propose this as a PR against current bids version, just keep surgery_date for the BEP032 but propose age_category and age_type .

It also would complement

Then it would give it a better chance for discussion etc.

Also I guess they should be added as recommended to
https://github.com/bids-standard/bids-specification/blob/master/src/schema/rules/tabular_data/modality_agnostic.yaml#L2

Copy link
Member Author

Choose a reason for hiding this comment

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

Done! Also, birthdate is another column suggested by the BEP032.

alpha_rotation:
name: alpha_rotation
display_name: Alpha rotation
description: |
Euler angle to match probe extension dimensions (width, height, depth) to global x, y, z coordinates.
unit:
degree
unit: degree
associated_brain_region:
name: associated_brain_region
display_name: Associated brain region
Expand All @@ -67,16 +83,22 @@ associated_brain_region_quality_type:
name: associated_brain_region_quality_type
display_name: Associated brain region quality type
description: |
The method used to identify the associated brain region (estimated|proof)
depending on anatomical pictures proofing the location or indirect estimation of the location.
The method used to identify the associated brain region (estimated|proof)
depending on anatomical pictures proofing the location or indirect estimation of the location.
type: string
birthdate:
name: birthdate
display_name: Birthdate
description: |
Day of birth of the participant. Datetime format and their anonymization are described in [Units](SPEC_ROOT/common-principles.md#units).
type: string
format: datetime
beta_rotation:
name: beta_rotation
display_name: Beta rotation
description: |
Euler angle to match probe extension dimensions (width, height, depth) to global x, y, z coordinates.
unit:
degree
unit: degree
cardiac:
name: cardiac
display_name: Cardiac measurement
Expand Down Expand Up @@ -231,8 +253,7 @@ gamma_rotation:
display_name: Gamma rotation
description: |
Euler angle to match probe extension dimensions (width, height, depth) to global x, y, z coordinates.
unit:
degree
unit: degree
group__channel:
name: group
display_name: Channel group
Expand Down Expand Up @@ -699,6 +720,14 @@ strain_rrid:
of the strain of the species, for example: `RRID:IMSR_JAX:000664`.
type: string
format: rrid
# TODO: Clarify if column values can be arrays.
surgery_date:
name: surgery_date
display_name: Surgery date
description: |
Date(s) of surgery. Datetime format and their anonymization are described in [Units](SPEC_ROOT/common-principles.md#units). The details of the surgery should be described in the sidecar json file.
type: string
format: datetime
time:
name: time
display_name: Time
Expand Down
21 changes: 21 additions & 0 deletions src/schema/objects/enums.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1405,3 +1405,24 @@ microvascular:
display_name: microvascular
description: |
The origin of a tissue: microvascular
postnatal:
value: postnatal
display_name: postnatal
description: |
This is the actual time that has passed since a subject's birth,
also known as “chronological age”.
If age_type is omitted, age is assumed to be this type.
fetal:
value: fetal
display_name: fetal
description: |
Also known as "embryonic age," this measures the age of a
fetus or embryo from the time of conception. It's typically about two weeks
less than the gestational age.
Copy link
Contributor

Choose a reason for hiding this comment

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

For humans, but not other species, right? Or is this common across a broad spectrum of species?

Copy link
Member Author

Choose a reason for hiding this comment

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

I am not sure. For now, I removed these changes from here as suggested by Yarik and moved them to #1839 where it reflects the bep032 doc in its current state.

gestational:
value: gestational
display_name: gestational
description: |
This measures the duration of pregnancy from the first day of the
mother's last menstrual period to the current date. This should be included
for experiments where some subjects have not been born.
Loading