improve conversion gallery documentation for CsvTimeIntervalsInterface
#1572
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the CSV/Excel TimeIntervals interface with comprehensive documentation improvements and a fix for in-memory access to trials and epochs. The changes improve user experience by providing detailed tutorial-style examples and fixing a gap in how TimeIntervals data is accessed before file save/load.
- Enhanced documentation with detailed CSV format requirements, examples, and usage patterns
- Fixed in-memory access to
nwbfile.trialsandnwbfile.epochsby setting direct properties - Improved docstrings for
TimeIntervalsInterface.add_to_nwbfile()andconvert_df_to_time_intervals()
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/neuroconv/tools/text.py | Expanded docstring for convert_df_to_time_intervals() with comprehensive parameter descriptions, examples, and notes |
| src/neuroconv/datainterfaces/text/timeintervalsinterface.py | Improved docstrings and added direct property assignment for trials/epochs to enable in-memory access |
| docs/conversion_examples_gallery/text/csv.rst | Major documentation enhancement with CSV format requirements, multiple usage examples, and customization options |
| CHANGELOG.md | Added changelog entry describing the improvements |
h-mayorquin
changed the title
CsvTimeIntervalsInterface
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1572 +/- ##
=======================================
Coverage 88.27% 88.27%
=======================================
Files 156 156
Lines 10695 10747 +52
=======================================
+ Hits 9441 9487 +46
- Misses 1254 1260 +6
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During a conversation with Matthew A. Smith, I suggested that the simplest path for converting MATLAB trial data to NWB is to export to CSV and use the
CsvTimeIntervalsInterfaceinterface.I took a look a the conversion gallery and realize that the current documentation doesn't adequately explain the expected CSV format or how to customize the conversion. This PR improves the conversion gallery by clarifying the input format and demonstrating the available conversion options.
The new how-to documentation:
https://neuroconv--1572.org.readthedocs.build/en/1572/conversion_examples_gallery/text/csv.html