BidsDataset

class BidsDataset(root_path, schema=None, suffixes=['events', 'participants'], exclude_dirs=['sourcedata', 'derivatives', 'code', 'stimuli'])

A BIDS dataset representation primarily focused on HED evaluation.

root_path

Real root path of the BIDS dataset.

Type:

str

schema

The schema used for evaluation.

Type:

HedSchema or HedSchemaGroup

file_groups

A dictionary of BidsFileGroup objects with a given file suffix.

Type:

dict

Methods

BidsDataset.__init__(root_path[, schema, ...])	Constructor for a BIDS dataset.
BidsDataset.get_file_group(suffix)	Return the file group of files with the specified suffix.
BidsDataset.get_summary()	Return an abbreviated summary of the dataset.
BidsDataset.validate([check_for_warnings, ...])	Validate the dataset.

Attributes

BidsDataset.__init__(root_path, schema=None, suffixes=['events', 'participants'], exclude_dirs=['sourcedata', 'derivatives', 'code', 'stimuli'])

Constructor for a BIDS dataset.

Parameters:

• root_path (str) – Root path of the BIDS dataset.

• schema (HedSchema or HedSchemaGroup) – A schema that overrides the one specified in dataset.

• suffixes (list or None) – File name suffixes of items to include. If None or empty, then [‘_events’, ‘participants’] is assumed.

• exclude_dirs=['sourcedata' –

• 'derivatives' –

• 'code' –

• 'phenotype'] –

BidsDataset.get_file_group(suffix)

Return the file group of files with the specified suffix.

Parameters:

suffix (str) – Suffix of the BidsFileGroup to be returned.

Returns:

The requested tabular group.

Return type:

BidsFileGroup or None

BidsDataset.get_summary()

Return an abbreviated summary of the dataset.

BidsDataset.validate(check_for_warnings=False, schema=None)

Validate the dataset.

Parameters:

• check_for_warnings (bool) – If True, check for warnings.

• schema (HedSchema or HedSchemaGroup or None) – The schema used for validation.

Returns:

List of issues encountered during validation. Each issue is a dictionary.

Return type:

list