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
  3. Specification v1.0
  4. data
  5. subjects
  6. studies

analysis

JSON array

PreviousparamsNextobservations

Last updated 9 months ago

Was this helpful?

Analysis results, run on an imaging study level. Can contain files, directories, and variables.

JSON variables

Variable

Type

Default

Description

DateStart

date

Datetime of the start of the analysis.

DateEnd

date

Datetime of the end of the analysis.

DateClusterStart

date

Datetime the job began running on the cluster.

DateClusterEnd

date

Datetime the job finished running on the cluster.

Hostname

string

If run on a cluster, the hostname of the node on which the analysis run.

PipelineName

string

Name of the pipeline used to generate these results.

PipelineVersion

number

1

Version of the pipeline used.

RunTime

number

0

Elapsed wall time, in seconds, to run the analysis after setup.

SeriesCount

number

0

Number of series downloaded/used to perform analysis.

SetupTime

number

0

Elapsed wall time, in seconds, to copy data and set up analysis.

Status

string

Status, should always be β€˜complete’.

StatusMessage

string

Last running status message.

Successful

bool

Analysis ran to completion without error and expected files were created.

Size

number

Size in bytes of the analysis.

VirtualPath

string

Relative path to the data within the package.

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

πŸ”΅
πŸ”΄
🟑
πŸ”΄
πŸ”΄
πŸ”΅
🟑
🟑