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
  • JSON variables
  • Directory structure

Was this helpful?

Export as PDF
  1. Contribute
  2. Squirrel data sharing format
  3. Specification v1.0
  4. data
  5. subjects

studies

JSON array

PrevioussubjectsNextseries

Last updated 2 months ago

Was this helpful?

An array of imaging studies, with information about each study. An imaging study (or imaging session) is defined as a set of related series collected on a piece of equipment during a time period. An example is a research participant receiving an MRI exam. The participant goes into the scanner, has several MR images collected, and comes out. The time spent in the scanner and all of the data collected from it is considered to be a study.

Valid squirrel modalities are derived from the DICOM standard and from NiDB modalities. Modality can be any string, but some squirrel readers may not correctly interpret the modality or may convert it to “other” or “unknown”. See full list of .

JSON variables

Variable
Type
Default
Description

AgeAtStudy

number

Subject’s age in years at the time of the study.

Datetime

datetime

Date of the study.

DayNumber

number

For repeated studies and clinical trials, this indicates the day number of this study in relation to time 0.

Description

string

Study description.

Equipment

string

Equipment name, on which the imaging session was collected.

Height

number

Height in meters of the subject at the time of the study.

Modality

string

Notes

string

Any notes about the study

StudyNumber

number

Study number. May be sequential or correspond to NiDB assigned study number.

StudyUID

string

DICOM field StudyUID.

TimePoint

number

Similar to day number, but this should be an ordinal number.

VisitType

string

Type of visit. ex: Pre, Post.

Weight

number

Weight in kilograms of the subject at the time of the study.

AnalysisCount

number

Number of analyses for this study.

SeriesCount

number

Number of series for this study.

VirtualPath

string

Relative path to the data within the package.

JSON array

Array of series.

JSON array

Array of analyses.

Directory structure

Files associated with this section are stored in the following directory. SubjectID and StudyNum are the actual subject ID and study number, for example /data/S1234ABC/1.

/data/<SubjectID>/<StudyNum>

Primary key Required Computed (squirrel writer/reader should handle these variables)

Defines the type of data. See table of supported .

🔵
🔴
🟡
🔴
🔴
🔴
🔴
🔴
🔵
🟡
🟡
🟡
modalities
series
analyses
modalities