squirrel vs BIDS

Understanding the differences between package formats

BIDS and squirrel are both file formats designed to store neuroimaging data. They are similar, but different in implementation. If you are familiar with BIDS, squirrel will be easy to understand.

squirrel vs BIDS objects

squirrel	BIDS	Notes
subject	sub- directory	The subject object. BIDS sub-* directories contain the ID. squirrel objects are identified by the ID.
study	ses- directory *_sessions.tsv	Session/imaging study object.
series	*.nii.gz files *.nii files anat directory func directory fmap directory ieeg directory perf directory eeg directory *events.json file *events.tsv file <modality>.json file	Mapping series within BIDS can be tricky. There is limited mapping between squirrel and BIDS for this object.
analysis	derivatives directory figures directory motion directory *_scans.tsv file	The analysis results object/directory.
pipeline	code directory	Code, pipelines, scripts to perform analysis on raw data.
experiment	task-*.json task-*.tsv	Details on the experiment.
root -> description	dataset_description.json	Details about the dataset.
root -> changes	CHANGES	Any information about changes from to this dataset from a previous version.
root -> readme	README README.md	More details about the dataset.
subject -> demographics	participants.tsv participants.json	Details about subject demographics.