JSON object
The data-dictionary object stores information describing mappings or any other descriptive information about the data. This can also contain any information that doesn't fit elsewhere in the squirrel package, such as project descriptions.
Examples include mapping numeric values (1,2,3,...) to descriptions (F, M, O, ...)
data-dictionary
data-dictionary-item
Files associated with this section are stored in the following directory.
/data-dictionary
Primary key Required Computed (squirrel writer/reader should handle these variables)
| Variable | Type | Default | Description |
|---|---|---|---|
| Variable | Type | Default | Description |
|---|---|---|---|
DataDictionaryName
string
Name of this data dictionary.
NumFiles
number
Number of files contained in the experiment.
Size
number
Size, in bytes, of the experiment files.
VirtualPath
string
Path to the data-dictionary within the squirrel package.
data-dictionary-item
JSON array
Array of data dictionary items. See next table.
VariableType
string
Type of variable.
VariableName
string
Name of the variable.
Description
string
Description of the variable.
KeyValueMapping
string
List of possible key/value mappings in the format key1=value1, key2=value2. Example 1=Female, 2=Male
ExpectedTimepoints
number
Number of expected timepoints. Example, the study is expected to have 5 records of a variable.
RangeLow
number
For numeric values, the lower limit.
RangeHigh
number
For numeric values, the upper limit.