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

subjects

JSON array

PreviousdataNextstudies

Last updated 2 months ago

Was this helpful?

This object is an array of subjects, with information about each subject.

JSON variables

Variable
Type
Default
Description (and possible values)

AlternateIDs

JSON array

List of alternate IDs. Comma separated.

DateOfBirth

date

Subject’s date of birth. Used to calculate age-at-study. Value can be YYYY-00-00 to store year only, or YYYY-MM-00 to store year and month only.

Gender

char

Gender.

GUID

string

Ethnicity1

string

NIH defined ethnicity: Usually hispanic, non-hispanic

Ethnicity2

string

NIH defined race: americanindian, asian, black, hispanic, islander, white

Notes

string

Notes about this subject

Sex

char

Sex at birth (F,M,O,U).

SubjectID

string

Unique ID of this subject. Each subject ID must be unique within the package.

InterventionCount

number

Number of intervention objects.

ObservationCount

number

Number of observation objects.

StudyCount

number

Number of studies.

VirtualPath

string

Relative path to the data within the package.

JSON array

Array of imaging studies/sessions.

JSON array

Array of observations.

JSON array

Array of interventions.

Directory structure

Files associated with this section are stored in the following directory

/data/<SubjectID>

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

Globally unique identifier, from the NIMH Data Archive ().

🔵
🔴
🟡
🔴
🔴
🔴
🔵
🟡
🟡
🟡
🟡
NDA
studies
observations
interventions