generate_bids_filename

bidsaid.files.generate_bids_filename(sub_id, desc, ext, ses_id=None, task_id=None, run_id=None)[source]

Generate a BIDs compliant filename.

Parameters

sub_idstr or int

Subject ID (i.e. 01, 101, etc).

descstr

Description of the file (i.e., T1w, bold, etc).

extstr

The extension of the file.

ses_idstr or int or None, default=None

Session ID (i.e. 001, 1, etc). Optional entity.

ses_idstr or int or None, default=None

Session ID (i.e. 001, 1, etc). Optional entity.

task_idstr or None, default=None

Task ID (i.e. flanker, n_back, etc). Optional entity.

run_idstr or int or None, default=None

Run ID (i.e. 001, 1, etc). Optional entity.

Returns

str

A BIDS compliant filename.