-
Notifications
You must be signed in to change notification settings - Fork 10
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
create json schema for electrophysiology metadata #18
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spaces in keys seems like it will lead to eternal pain for implementers. If something is needed for display purposes it should be decoupled from the internal schema spec.
"subject id", | ||
"subject age", | ||
"subject sex", | ||
"subject date of birth", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many groups will not be able to supply this, what is the failure mode if they cannot and this is required? N/A
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing that might be possible to require that all groups could supply is age category.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The point of this document is to guide researchers to what data they should record (and to come to a common consensus about it). Maybe we don't have date_of_birth for old data, but we should be able to collect it for future sessions.
I don't really like the idea of filler for required fields. We have optional fields and if we want to make this optional we can do that. But whatever fields we mark as required, there will of course be datasets that are missing it, and what to do in those cases is more of a policy question. I prefer having minimal rules and enforcing them strictly rather than having strict rules and enforcing them leniently, but there will probably be a mix of both. Ultimately, we'll need to come up with a strategy that promotes adherence to these rules with minimal hindering of data sharing.
I do think it is a bit redundant to have subject_age and subject_date_of_birth.
What do you mean by age category? Is that something we can standardize across groups?
"properties": { | ||
"value": { | ||
"type": "string", | ||
"description": "Using ISO 8601 duration" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does this handle ages reported as P14
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does P14 mean 14 days after birth? Then age in ISO 8106 would be P14D
.
"citation policy", | ||
"institution", | ||
"genotype", | ||
"cre line", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"cre line", | |
"cre line", | |
"driver line", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does making this required interact with mice that are wildtype?
"citation_policy": {"type": "string"}, | ||
"institution": {"type": "string"}, | ||
"genotype": {"type": "string"}, | ||
"cre line": {"type": "string"}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest requiring an RRID here given that we have already gotten agreement that mice in published papers be registered with MGI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems reasonable to me, but I don't know much about RRID usage within BICCN
created based on the IC Ephys Metadata document