LogoLogo
  • 🐿️NeuroInformatics Database
    • HIPAA Compliance
  • Getting Started
    • Installation
      • Quick Install
      • How to change passwords
      • Optional software
      • MySQL/MariaDB tweaks
    • Upgrade
      • Quick Upgrade
      • Migrate Existing Installation
  • Using NiDB
    • User's Guide
      • Importing data
      • Managing data
      • Finding & exporting data
      • Managing projects
      • Pipelines & analysis
      • Calendar
    • Administration
      • Front end (user facing)
      • Back end
      • nidb command line
  • Specifications
    • Data Storage Hierarchy
    • DICOM Anonymization
  • Tutorials
    • Working with Imaging Data
      • Uploading data for a sample project
      • Troubleshooting Missing Imaging Data
      • Import DICOM data
      • MR scan quality control
    • Manipulating Subjects, Studies, & Series
      • Working with subject IDs
      • Renaming series
    • Pipelines
    • Working with Redcap
      • Importing Data from a Redcap Project
      • Importing Subjects from Redcap
      • Reports based on data imported from Redcap
    • Analysis Builder
    • Administration of Users, Projects, & System
      • User Permissions
      • Creating new projects
      • Adding Users to Projects
      • Editing the config file
      • Deleting all the data
  • Contribute
    • Squirrel data sharing format
      • squirrel utilities
      • Using the squirrel library
      • Example package
      • squirrel vs BIDS
      • Specification v1.0
        • Package root
        • package
        • data
          • subjects
            • studies
              • series
                • params
              • analysis
            • observations
            • interventions
          • group-analysis
        • pipelines
          • data-steps
          • Pipeline scripts
        • experiments
        • data-dictionary
        • Modalities
      • Building squirrel library and utils
        • Building Python Wrapper
    • Building NiDB
    • Creating a Development VM
  • Help!
    • Github Issues
    • Github Discussions
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Contribute
  2. Squirrel data sharing format

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.

PreviousExample packageNextSpecification v1.0

Last updated 20 days ago

Was this helpful?