inspectNwbFile

inspectNwbFile(nwbFilepath, options)[source]

INSPECTNWBFILE - Run nwbinspector on the specified NWB file

Syntax:

report = INSPECTNWBFILE(nwbFilepath) runs nwbinspector on the NWB file at nwbFilepath and returns a tabular report listing potential issues.

report = INSPECTNWBFILE(nwbFilepath, Name, Value) runs nwbinspector using optional name-value pairs for customizing the report.

Input Arguments:

nwbFilepath (string) - Filepath pointing to an NWB file.
options (name-value pairs) - Optional name-value pairs. Available options:
- VariableOrder (string) - Which order to arrange the variables in the tabular report.

Output Arguments:

report (table) - A tabular report listing nwbinspector issues

Usage:

Example 1 - Inspect an NWB file:

report = inspectNwbFile('my_nwb_file.nwb');

Example 2 - Inspect an NWB file and specify the order to display report variables:

variableOrder = ["importance", "message", "check_function_name", "object_name"];
nwb = inspectNwbFile('my_nwb_file.nwb', ...
    'VariableOrder', variableOrder);

Note

This function requires the python nwbinspector module to be installed and available from MATLAB. From MATLAB R2019, it is possible to run python modules directly from MATLAB. Ensure nwbinspector is installed in the python environment returned by running pyenv in MATLAB. It is also possible to run the command line (CLI) version of nwbinspector. If the nwbinspector executable is not on your system’s path, you can add the executable to your MATLAB environment variables using the variable name “NWBINSPECTOR_EXECUTABLE”, for example setenv(“NWBINSPECTOR_EXECUTABLE”, ‘path/to/python/ver/bin/nwbinspector’)

Note

This function is meant as a convenience method for running the nwbinspector as part of an MatNWB workflow, and it does not expose more advanced functionality of the nwbinspector.