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

offer default ProcessingModules named "behavior", "ecephys", etc. #946

Open
5 tasks done
bendichter opened this issue May 20, 2019 · 2 comments · May be fixed by #1944
Open
5 tasks done

offer default ProcessingModules named "behavior", "ecephys", etc. #946

bendichter opened this issue May 20, 2019 · 2 comments · May be fixed by #1944
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users

Comments

@bendichter
Copy link
Contributor

Feature Request

In an effort to help usability and to encourage best practices, we should offer default processing modules. This will require the following:

  • a (non-breaking) schema change adding optional ProcessingModules to /processing.
  • helper API functions for easily accessing these ProcessingModule objects.

My preferred syntax for the API change would be that nwb.processing.behavior would return the ProcessingModule named behavior if it exists, and if it does not exist pynwb would automatically create that module and return it.

Checklist

  • Have you ensured the feature or change was not already reported ?
  • Have you included a brief and descriptive title?
  • Have you included a clear description of the problem you are trying to solve?
  • Have you included a minimal code snippet that reproduces the issue you are encountering?
  • Have you checked our Contributing document?
@rly
Copy link
Contributor

rly commented Jun 18, 2019

I am in favor of default names, but we should be internally consistent. Within the general group, there are already the names extracellular_ephys, intracellular_ephys, etc. Whichever we pick, I think they should be consistent.

@rly
Copy link
Contributor

rly commented Jun 18, 2019

See related NeurodataWithoutBorders/nwb-schema#249

@stephprince stephprince added category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users labels Apr 16, 2024
@rly rly linked a pull request Aug 4, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants