Added conversion gallery showcasing NWB to BIDS field mappings #288
Conversation
* Initial plan * Add conversion gallery documentation with NWB to BIDS mapping examples Co-authored-by: CodyCBakerPhD <51133164+CodyCBakerPhD@users.noreply.github.com> * Fix conversion gallery assertions and improve metadata descriptions Co-authored-by: CodyCBakerPhD <51133164+CodyCBakerPhD@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: CodyCBakerPhD <51133164+CodyCBakerPhD@users.noreply.github.com>
CodyCBakerPhD
changed the title
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #288 +/- ##
==========================================
- Coverage 84.75% 84.57% -0.18%
==========================================
Files 38 38
Lines 1456 1465 +9
==========================================
+ Hits 1234 1239 +5
- Misses 222 226 +4
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
| # TODO: fix this | ||
|
|
||
| .. code-block:: json | ||
|
|
||
| {} |
There was a problem hiding this comment.
I'm thinking I'll fix all these at once in a follow-up if you're OK with that
…into conversion_gallery
| .. literalinclude:: ./expected_files/sub-001_sessions.tsv | ||
| :language: text | ||
|
|
||
| .. invisible-code-block: python | ||
|
|
||
| test_sessions_tsv_path = bids_directory / "sub-001" / "sub-001_sessions.tsv" | ||
| expected_sessions_tsv_path = expected_files / "sub-001_sessions.tsv" | ||
|
|
||
| test_bytes = test_sessions_tsv_path.read_bytes() | ||
| expected_bytes = expected_sessions_tsv_path.read_bytes() | ||
| assert test_bytes == expected_bytes |
There was a problem hiding this comment.
I'm thinking this could be a good pattern for testing the tree structure perhaps? (would need custom parser for special branch symbols)
There was a problem hiding this comment.
seems reasonable. maybe we need to document how to regenerate the expected_files if things change though.
There was a problem hiding this comment.
'Copy and paste from your nwb2bids_tutorial/ecephys_tutorial_file/bids_dataset_py_1 directory' lol
|
@asmacdo Ready for review finally |
Co-authored-by: Austin Macdonald <austin@dartmouth.edu>
Co-authored-by: Austin Macdonald <austin@dartmouth.edu>
Co-authored-by: Austin Macdonald <austin@dartmouth.edu>
asmacdo
left a comment
asmacdo
left a comment
There was a problem hiding this comment.
s/specifies/specified then good to go!
Initial draft created with the help of Claude
Needs significant reduction and cleanup