# analysis

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

<figure><img src="https://mermaid.ink/img/pako:eNqVlEFrgzAUx7-KpAgKOspwFwc9bZcxNlhvw8uredasaiSJW6X0uy9RY6vtofVg3j_5_fOS99ADSTlFEpOtgDp33r-SytGP4Fx5b-vPjy7yw3BFQYFnXv7zCdHzNaQ72KI3jPNVVmPBKpTeGM0I3NcoWImVkt5ZPKNM4pCyVDFegWi9mfZ7uJsNV1vBmxoqKFqpE3fKsdLuO6Cy2fxgqlPbwK5bbRjVUKY3GsYrBN9IFL9gDiO9c3GFZZXSy_qKHTxRI90nMql1OUzmbrhc7i_FpGcDi7hubwkfTIMElDJjhemRCS10iZqiGFBOGu26Z30x2En28Ek73YRvfWPPu3MMovdYNXPYixiDjXuDVRPDeAXVFuiMxzdMES-yLAt0tQTfYUhB5iAEtPHj1DTJco9xVoV7rJNS3GKc2ceO3uKdXnN04NNyGfSeeBFF0RCHf4yqPI7qPQlIiaIERvXf4WD2SojKscSExDqkmEFTqIQk1VGjTa2rj6-UKS5InEEhMSDQKL5uq5TESjRooRcG-mdTjpT-VL85t_r4Dw0uklg?type=png" alt=""><figcaption></figcaption></figure>

### JSON variables

:blue\_circle: Primary key\
:red\_circle: Required\
:yellow\_circle: Computed (squirrel writer/reader should handle these variables)

<table data-header-hidden data-full-width="true"><thead><tr><th width="215" align="right"></th><th width="108.00000000000003"></th><th width="102"></th><th></th></tr></thead><tbody><tr><td align="right"><strong>Variable</strong></td><td><strong>Type</strong></td><td><strong>Default</strong></td><td><strong>Description</strong></td></tr><tr><td align="right"><code>DateStart</code></td><td>date</td><td><span data-gb-custom-inline data-tag="emoji" data-code="1f534">🔴</span></td><td>Datetime of the start of the analysis.</td></tr><tr><td align="right"><code>DateEnd</code></td><td>date</td><td></td><td>Datetime of the end of the analysis.</td></tr><tr><td align="right"><code>DateClusterStart</code></td><td>date</td><td></td><td>Datetime the job began running on the cluster.</td></tr><tr><td align="right"><code>DateClusterEnd</code></td><td>date</td><td></td><td>Datetime the job finished running on the cluster.</td></tr><tr><td align="right"><code>Hostname</code></td><td>string</td><td></td><td>If run on a cluster, the hostname of the node on which the analysis run.</td></tr><tr><td align="right"><code>PipelineName</code></td><td>string</td><td><span data-gb-custom-inline data-tag="emoji" data-code="1f534">🔴</span> <span data-gb-custom-inline data-tag="emoji" data-code="1f535">🔵</span></td><td>Name of the pipeline used to generate these results.</td></tr><tr><td align="right"><code>PipelineVersion</code></td><td>number</td><td><code>1</code></td><td>Version of the pipeline used.</td></tr><tr><td align="right"><code>RunTime</code></td><td>number</td><td><code>0</code></td><td>Elapsed wall time, in seconds, to run the analysis after setup.</td></tr><tr><td align="right"><code>SeriesCount</code></td><td>number</td><td><code>0</code></td><td>Number of series downloaded/used to perform analysis.</td></tr><tr><td align="right"><code>SetupTime</code></td><td>number</td><td><code>0</code></td><td>Elapsed wall time, in seconds, to copy data and set up analysis.</td></tr><tr><td align="right"><code>Status</code></td><td>string</td><td></td><td>Status, should always be ‘complete’.</td></tr><tr><td align="right"><code>StatusMessage</code></td><td>string</td><td></td><td>Last running status message.</td></tr><tr><td align="right"><code>Successful</code></td><td>bool</td><td></td><td>Analysis ran to completion without error and expected files were created.</td></tr><tr><td align="right"><code>Size</code></td><td>number</td><td><span data-gb-custom-inline data-tag="emoji" data-code="1f7e1">🟡</span></td><td>Size in bytes of the analysis.</td></tr><tr><td align="right"><code>VirtualPath</code></td><td>string</td><td><span data-gb-custom-inline data-tag="emoji" data-code="1f7e1">🟡</span></td><td>Relative path to the data within the package.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.neuroinfodb.org/nidb/contribute/squirrel-data-sharing-format/specification-v1.0/data/subjects/studies/analysis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
