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

Package root

JSON object

PreviousSpecification v1.0Nextpackage

Last updated 9 months ago

Was this helpful?

The package root contains all data and files for the package. The JSON root contains all JSON objects for the package.

JSON variables

Variable
Type
Default
Description

JSON object

Package information.

JSON object

Raw and analyzed data.

JSON object

Methods used to analyze the data.

JSON object

Experimental methods used to collect the data.

JSON object

Data dictionary containing descriptions, mappings, and key/value information for any variables in the package.

NumPipelines

number

Number of pipelines.

NumExperiments

number

Number of experiments.

TotalFileCount

number

Total number of data files in the package, excluding .json files.

TotalSize

number

Total size, in bytes, of the data files.

Directory structure

Files associated with this object are stored in the following directory.

/

Computed (squirrel writer/reader should handles these variables)

🟡
🟡
🟡
🟡
🟡
package
data
pipelines
experiments
data-dictionary