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 best-practices guide on how to design an extension #54

Open
oruebel opened this issue Aug 8, 2022 · 1 comment
Open

Add best-practices guide on how to design an extension #54

oruebel opened this issue Aug 8, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@oruebel
Copy link
Contributor

oruebel commented Aug 8, 2022

Participants at the 2022 NWB User Days suggested that it would be useful to create a "Best-practices guide on how to design an extension", which would cover topics such as:

  • When to use Groups, Datasets, Attributes, Link etc.
  • Best practices for data type, quantity, assignment of neurodata_types etc.
  • Extension design principles
  • Core data modeling principles
  • How to best pick neurodata_type to build from. Also include common example use cases. E.g., example for extending LabMetaData (Here is an example for adding cell_id. NOTE: cell_id has been added in NWB so we should use a different example)

I would suggest adding a new section at the end of the extension tutorial on "Best practices for designing extensions" . Alternatively this could also be part of the PyNWB or HDMF documentation, but I think it may fit better here.

@oruebel oruebel added the documentation Improvements or additions to documentation label Aug 8, 2022
@oruebel
Copy link
Contributor Author

oruebel commented Aug 26, 2022

See also NeurodataWithoutBorders/pynwb#1542

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants