docs(tutorials): add a tutorial for external resource references - #885
Open
ehennestad wants to merge 4 commits into
Open
docs(tutorials): add a tutorial for external resource references#885ehennestad wants to merge 4 commits into
ehennestad wants to merge 4 commits into
Conversation
ehennestad
force-pushed
the
herd-tutorial
branch
from
August 31, 2026 10:43
8ec10f0 to
91567dc
Compare
Collaborator
Author
The last half of this paragraph is unclear - Either improve or drop it completely (The main point here is that the column itself is added as an attribute, not an index column) |
ehennestad
force-pushed
the
herd-tutorial
branch
from
August 31, 2026 14:25
91567dc to
265c24f
Compare
ehennestad
force-pushed
the
herd-tutorial
branch
from
September 1, 2026 11:40
265c24f to
b6bf4c9
Compare
ehennestad
marked this pull request as ready for review
September 1, 2026 11:52
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## add-herd-user-api #885 +/- ##
==================================================
Coverage 95.36% 95.36%
==================================================
Files 237 237
Lines 8660 8660
==================================================
Hits 8259 8259
Misses 401 401 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Walk through annotating values in a file with HERD: create a file, record what a subject's species refers to in the NCBI Taxonomy, annotate a column of an electrodes table with a brain region, read the annotations back, and write and reload the file. Follows the PyNWB external resources tutorial, so a reader can move between the two APIs, and covers the same ground except for storing a HERD outside a file, which MatNWB does not support yet. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Give the tutorial a page under General Tutorials, following the layout the other tutorial pages use: a link to open it in MATLAB Online, a link to the full page, and the exported HTML embedded in the page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Run matnwb_exportTutorials for the new tutorial, which stores its outputs in the live script, writes the HTML the documentation page embeds, and writes the plain code listing alongside the other tutorials. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Point each mention of HERD and Subject at its type documentation, so a reader can look up what the type holds without leaving the tutorial. Re-export the tutorial so the embedded HTML and the code listing match. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
ehennestad
force-pushed
the
herd-tutorial
branch
from
September 1, 2026 14:42
eff462c to
0b4c7ae
Compare
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
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.
Motivation
Add a tutorial for the HERD API, mirroring the PyNWB external resources tutorial so a reader can move between the two APIs.
Preview tutorial on ReadTheDocs:
https://matnwb--885.org.readthedocs.build/en/885/pages/tutorials/externalResources.html
What changed
tutorials/externalResources.mlxrecords and reads back external resource references on a file it builds itself: a subject's species, and a column of an electrodes table.Storing a HERD outside a file is left out, because
to_zipandfrom_zipare not implemented in MatNWB.How to test
Todo
Checklist
fix #XXwhereXXis the issue number?🤖 Generated with Claude Code