Plugins

Note

This page consists of plugins distributed with Snakebids. Externally developed and distributed plugins may be missing from this page.

BidsValidator

class snakebids.plugins.validator.BidsValidator(raise_invalid_bids=True)

Snakebids plugin to perform validation of a BIDS dataset using the bids-validator. If the dataset is not valid according to the BIDS specifications, an InvalidBidsError is raised.

Parameters:

raise_invalid_bids (bool) – Flag to indicate whether InvalidBidsError should be raised if BIDS validation fails. Default to True.

__call__(app)

Perform BIDS validation of dataset.

Parameters:

app (SnakeBidsApp) – Snakebids application to be run

Raises:

InvalidBidsError – Raised when the input BIDS directory does not pass validation with the bids-validator

Return type:

None