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

dandiset.yaml: add "standards" section? #142

Open
yarikoptic opened this issue Mar 4, 2020 · 1 comment
Open

dandiset.yaml: add "standards" section? #142

yarikoptic opened this issue Mar 4, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@yarikoptic
Copy link
Member

I envision it to be primarily an auto-populated (e.g. using dandi organize) list of records with fields

  • name: name of the standard (nwb, bids, dandiset, dandi-layout if we do not enforce, ...)
  • versions: string or a list of strings - versions of the corresponding standard found in the dandiset (e.g., .nwb files could be a cocktail of NWB versions)
  • extensions: a list of detected extensions to the standard (e.g., could be NWB extensions, nifti extensions, etc) probably again as a list of records with version field.
  • options: this one is debatable one. I thought to (ab)use it to e.g. describe dandi-layout options (minimization of keys, or entire filename pattern, etc).

It might be that it would even relate to the "scope" aspect (#1) but likely it is too inherent within dandiset.yaml itself, and should eventually be described there.

Purpose: provide overview in the used standards. Could simplify search for datasets of particular qualities (bids, or the ones consistently layed out with dandi organize) .

@yarikoptic yarikoptic added the enhancement New feature or request label Mar 4, 2020
@yarikoptic
Copy link
Member Author

I think "standards" are already reflected in our dandi-schema. NWB extensions aren't and I don't think options should be part of dandiset.yaml although might. I will transfer this to dandi-schema since discussing those might still have value.

@yarikoptic yarikoptic transferred this issue from dandi/dandi-core Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant