Skip to contents

All functions

anat_parser()
Anatomical parser constructor
bids_check_compliance()
Basic BIDS Compliance Checks
bids_heatmap()
Create a specialized heatmap visualization of BIDS data
bids_parser()
BIDS filename parsers using regex
bids_project()
Create a BIDS Project Object
bids_subject() bids_subject.bids_project()
Access a single subject from a BIDS project
bids_summary()
Summarize a BIDS dataset
brain_mask()
Retrieve a brain mask for a subject
check_func_scans()
Check Functional Scans in a BIDS Project
clear_example_bids_cache()
Clear Example BIDS Dataset Cache
confound_files()
Get confound files from a BIDS project
confound_files(<bids_project>)
Locate confound files
create_mock_bids()
Create a Mock BIDS Project Object
create_preproc_mask(<mock_bids_project>)
Create Preprocessing Mask (Mock Implementation)
create_preproc_mask()
Create a preprocessing mask from BIDS data
create_preproc_mask(<bids_project>)
Create a binary brain mask from preprocessed scans
encode()
Encode a string into a BIDS key-value list
event_files()
Get event files from a BIDS project
file_pairs()
Find File Pairs in a BIDS Project
flat_list()
Get "flat" representation of BIDS Project
fmap_parser()
Fieldmap parser constructor
fmriprep_anat_parser()
fMRIPrep anatomical parser constructor
fmriprep_func_parser()
fMRIPrep functional parser constructor
func_parser()
Functional parser constructor
func_scans()
Get functional scans from a BIDS project
func_scans(<bids_project>)
Get Functional Scans from a BIDS Project
get_example_bids_dataset()
Download Example BIDS Dataset
get_repetition_time()
Get Repetition Time (TR) from a sidecar JSON
load_all_events()
Load All Event Files
parse()
Parse a file-name into BIDS components
participants()
Get participants from a BIDS project
participants(<mock_bids_project>)
Get Participants from Mock BIDS Project
plot(<bids_project>) plot(<mock_bids_project>)
Plot a BIDS project as a dendrogram
plot_bids()
Plot a comprehensive visual overview of a BIDS project
preproc_scans()
Get preprocessed functional MRI scans
preproc_scans(<bids_project>)
Get preprocessed scans from a BIDS project
print(<mock_bids_project>)
Print Mock BIDS Project Summary
read_confounds()
Read Confound Files from a BIDS Project
read_confounds(<bids_project>)
Read confound files
read_confounds(<mock_bids_project>)
Read Confound Files (Mock Implementation)
read_events()
Read Event Files from a BIDS Project
read_events(<bids_project>)
Read event files from a BIDS project
read_events(<mock_bids_project>)
Read Event Files from Mock BIDS Project
read_func_scans.bids_project()
Read in a set of four-dimensional functional scans
read_preproc_scans.bids_project()
Read preprocessed functional MRI scans from a BIDS project
read_sidecar()
Read sidecar JSON files and return metadata as a tidy tibble
search_files()
Search files in BIDS structure
search_files(<mock_bids_project>)
Search Files in Mock BIDS Structure
sessions()
Get sessions from a BIDS project
sessions(<mock_bids_project>)
Get Sessions from Mock BIDS Project
tasks()
Get tasks from a BIDS project
tasks(<mock_bids_project>)
Get Tasks from Mock BIDS Project