Add NWBInspector to the upload documentation #40
Merged
Conversation
This file contains 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
satra
reviewed
Mar 20, 2022
docs/10_using_dandi.md
Outdated
Comment on lines
124
to
129
| 1. Thoroughly read through the NWBInspector report and try to address as many issues as possible. | ||
| Some autodetected violations, such as `check_data_orientation`, may be safely ignored in the event that the data is indeed confirmed to be in the correct form. | ||
| If the report is too large to efficiently navigate in your console, a report can be saved using | ||
|
|
||
| nwbinspector <source_folder> --report-save-path <report_location>.txt | ||
|
|
There was a problem hiding this comment.
perhaps some suggestion to do this on a few files first before converting everything would be useful.
There was a problem hiding this comment.
Indeed, I've enhanced the description to reflect the ideal workflow (running on small amounts of data, and running the inspector as early in the process as possible, and as often as possible).
2 tasks
CodyCBakerPhD
commented
Mar 23, 2022
|
@CodyCBakerPhD - i'm going to merge this in, now that this is in the cli. also please see #42 |
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.
Hello everyone!
With the NWBInspector project converging on a final stable API, we're looking to start encouraging more widespread usage prior even to the early stages of DANDI validation. While these steps are technically optional right now, and
dandi validation(also see PR #941) should catch any missing required metadata, we hope this should help improve the overall quality of NWBFiles that are ultimately uploaded.Listing this in draft for the moment while we finalize a couple things on our side with regards to documentations and documentation links.
CC: @bendichter