create_bids_file

bidsaid.files.create_bids_file(src_file, sub_id, desc, ses_id=None, task_id=None, run_id=None, dst_dir=None, remove_src_file=False, return_bids_filename=False)[source]

Create a BIDS compliant filename with required and optional entities.

Parameters

src_filestr or Path: Path to the source file.
sub_idstr or int: Subject ID (i.e. 01, 101, etc).
descstr: Description of the file (i.e., T1w, bold, etc).
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.
dst_dirstr, Path, or None, default=None: Directory name to copy the BIDS file to. If None, then the BIDS file is copied to the same directory as the src_file. Directory will also be created if it does not exist.
remove_src_filestr, default=False: Delete the source file if True.
return_bids_filenamestr, default=False: Returns the full BIDS filename if True.

Returns

Path or None: If return_bids_filename is True, then the BIDS filename is returned.

Note

There are additional entities that can be used that are not included in this function.