bids-validate 0.0.1

BIDS validation: filename patterns, dataset_description checks
Documentation
  • Coverage
  • 100%
    20 out of 20 items documented0 out of 13 items with examples
  • Size
  • Source code size: 23.48 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.72 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 40s Average build duration of successful builds.
  • all releases: 40s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • eugenehp

BIDS dataset validation utilities.

Provides functions for validating BIDS dataset roots, derivative directories, and file indexing patterns. Used by bids-layout during dataset indexing to determine which files to include or exclude.

Root Validation

[validate_root()] checks that a path exists, is a directory, and contains a valid dataset_description.json. If validation is enabled, the description is parsed and checked for required fields.

Derivative Validation

[validate_derivative_path()] ensures derivative datasets have a valid dataset_description.json with pipeline information (either GeneratedBy or the legacy PipelineDescription).

Ignore / Force Patterns

Default ignore patterns exclude code/, models/, sourcedata/, stimuli/, hidden files (.-prefixed), and common non-BIDS directories. These can be overridden with custom patterns via [validate_indexing_args()].