Instrument

Describes the instrument used for data acquisition.

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.

Summary view. Full reference → on behaverse.org/schemas.

Identifier

Field	Type	Requirement	Description
instrument_id	string	required	Unique identifier of an instrument. It can be formed by combining name and version (e.g., “DS_v2024.01”).
timeline_id	string	required	Identifier 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_id	string	required	Specific 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

Field	Type	Requirement	Description
name	string	required	Name 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”).
version	string	optional	Refers to the specific version/build of a particular instrument. We will use a calendar based versioning system (calver.org; e.g., “v2024.01”).
description	string	optional	A human readable, compact description of the main aspects of the instrument.
link	url	optional	External link, if any, the provides more information about the instrument, e.g., on Cognitive Atlas. Note: Permanent links, e.g., DOIs, are preferred over particular websites.