Skip to main content

Instrument

Describes the instrument used for data acquisition.

note

this table includes information about specific parameterizations of the instruments (i.e., timelines). For example, parameters for the software that executes the presentation of the stimuli and records key presses.

Identifier

FieldTypeRequirementDescription
instrument_idstringrequiredUnique identifier of an instrument. It can be formed by combining name and version (e.g., "DS_v2024.01").
timeline_idstringrequiredIdentifier for a timeline. Timeline is a variant of an instrument with specific parametrization, for the whole experiment or for multiple block of trials (e.g., "DS_FORWARD" and "DS_BACKWARD" for digit span task). Timelines are configurations that specify instrument parameters.
block_idstringrequiredSpecific parameterization of the instrument for a single block of trials (e.g., "DS_FORWARD_PRACTICE" and "DS_FOWARD_TEST"). Block-level parameters override timeline-level parameters.

What

FieldTypeRequirementDescription
namestringrequiredName of the toolkit (scene, code, or configuration) that is used to collect the data, e.g., "DS" for a software that runs digit span task in forward OR backward order. The specific parameterization of the instrument is defined by the "Timeline" (e.g., a variant of instrument called "DS_FORWARD").
versionstringoptionalRefers to the specific version/build of a particular instrument. We will use a calendar based versioning system (calver.org; e.g., "v2024.01").
descriptionstringoptionalA human readable, compact description of the main aspects of the instrument.
linkurloptionalExternal link, if any, the provides more information about the instrument, e.g., on Cognitive Atlas.