Version: v2.0.0-rc6

StudyMetadata

The StudyMetadata is used to describe certain properties of a study. Some of this data is displayed on the landing page when running the app, such as the title and description. Below is an example of a StudyMetadata entry in your study configuration file:

"studyMetadata" : {
 "title": "My New Study",
 "version": "pilot",
 "authors": [
   "Jane Doe",
   "John Doe"
 ],
 "date": "2024-04-01",
 "description": "This study is meant to test your ability.",
 "organizations": [
   "The reVISit Team",
   "The Other Team"
 ]
}

Properties

Property	Type	Description	Defined in
`authors`	`string`[]	The authors of your study.	parser/types.ts:54
`date`	`string`	The date of your study, may be useful for the researcher.	parser/types.ts:56
`description`	`string`	The description of your study, shown on the landing page.	parser/types.ts:58
`organizations`	`string`[]	The organizations that are associated with your study.	parser/types.ts:60
`title`	`string`	The title of your study, shown on the landing page.	parser/types.ts:50
`version`	`string`	The version of your study. When you change a configuration file after a study has already been distributed to participants, you can change the version number so that the participants who see this new configuration file can be identified.	parser/types.ts:52

Properties​

Properties