You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/typedoc/index.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
# Reference Documentation
2
2
3
-
## General reVISit
3
+
## General reVISit
4
4
5
-
-[GlobalConfig](interfaces/GlobalConfig.md) — The GlobalConfig is used to generate the list of available studies in the UI.
5
+
-[GlobalConfig](interfaces/GlobalConfig.md) — The GlobalConfig is used to generate the list of available studies in the UI.
6
6
7
7
## Data Formats
8
8
9
9
-[ParticipantData](interfaces/ParticipantData.md) – The ParticipantData is a JSON object that includes data for a participant in your study. This is how the data is stored in the database and how it will download with the JSON downloader.
10
-
-[StoredAnswer](interfaces/StoredAnswer.md) - The StoredAnswer object is a data structure describing the participants interaction with an individual component. It is used by ParticipantData to store individual answers.
10
+
-[StoredAnswer](interfaces/StoredAnswer.md) - The StoredAnswer object is a data structure describing the participant's interaction with an individual component. It is used by ParticipantData to store individual answers.
11
11
12
12
## reVISit Spec
13
13
14
-
-[StudyConfig](interfaces/StudyConfig.md) – The StudyConfig interface is used to define the properties of a study configuration. This is a JSON object with four main components: the StudyMetadata, the UIConfig, the Components, and the Sequence.
14
+
-[StudyConfig](interfaces/StudyConfig.md) – The StudyConfig interface is used to define the properties of a study configuration. This is a JSON object with four main components: the StudyMetadata, the UIConfig, the Components, and the Sequence.
15
15
-[StudyMetadata](interfaces/StudyMetadata.md) – A top-level property of the `StudyConfig`. The study metadata defines elements such as the study title, authors, and description.
16
16
-[UIConfig](interfaces/UIConfig.md) – A top-level property of the `StudyConfig`, defining the appearance of the study.
17
17
@@ -21,7 +21,7 @@ For other components of the reVISit spec see [Components](#components) and [Sequ
21
21
22
22
Components contain study-specific content. See the [How does it Work](https://revisit.dev/docs/getting-started/how-does-it-work) guide for an introduction.
Responses allow study designers to collect responses from participants Responses are included on administrative forms, such as consent or training, but most importantly as a response to a stimulus.
35
+
Responses allow study designers to collect responses from participants. Responses are included on administrative forms, such as consent or training, but most importantly as a response to a stimulus.
Matrix-style options that can be used for numerical or categorical responses:
68
68
-[MatrixResponse](interfaces/MatrixResponse.md)
69
69
70
-
You can specify numerical and textual responses through those interfaces:
70
+
You can specify numerical and textual responses through those interfaces:
71
71
-[NumberOption](interfaces/NumberOption.md)
72
72
-[StringOption](interfaces/StringOption.md)
73
73
@@ -86,7 +86,7 @@ Sequencing determines the order in which components appear.
86
86
87
87
Interruptions augment the sequence with components that are inserted either randomly or deterministically. These might be for breaks or attention checks.
Defined in: [parser/types.ts:870](https://github.com/revisit-studies/study/blob/317436dc2065f4bc80347c4bd7250d4444518b6d/src/parser/types.ts#L870)
3
+
Defined in: [parser/types.ts:927](https://github.com/revisit-studies/study/blob/0246def09f8a8d3a9193428f2d57948507c787cd/src/parser/types.ts#L927)
4
4
5
5
The Answer interface is used to define the properties of an answer. Answers are used to define the correct answer for a task. These are generally used in training tasks or if skip logic is required based on the answer.
6
6
7
7
Answers are used to defined correct answers for a task. These are generally used in training tasks or if skip logic is required based on the answer. The answer field is used to define the correct answer to the question. The acceptableLow and acceptableHigh fields are used to define a range of acceptable answers (these are currently only used for training). For example, if the correct answer is 5, and the acceptableLow is 4 and the acceptableHigh is 6, then any answer between 4 and 6 will be considered correct.
8
8
9
9
Here's an example of how to use the Answer interface to define the correct answer to a question:
10
10
11
-
```js
11
+
```json
12
12
{
13
-
"type":"markdown",
14
-
"path":"<study-name>/assets/question.md",
15
-
"response": [
16
-
{
17
-
"id":"response1",
18
-
"prompt":"What is 2 + 2?",
19
-
"location":"belowStimulus",
20
-
"type":"numerical"
21
-
}
22
-
],
23
-
"correctAnswer": [{
24
-
"id":"response1",
25
-
"answer":4
26
-
}]
27
-
}
13
+
"type": "markdown",
14
+
"path": "<study-name>/assets/question.md",
15
+
"response": [
16
+
{
17
+
"id": "response1",
18
+
"prompt": "What is 2 + 2?",
19
+
"location": "belowStimulus",
20
+
"type": "numerical"
21
+
}
22
+
],
23
+
"correctAnswer": [{
24
+
"id": "response1",
25
+
"answer": 4
26
+
}]
27
+
}
28
28
```
29
29
30
30
In this example, the correct answer to the question "What is 2 + 2?" is 4. If the participant answers 4, they will be considered correct. If they answer anything other than 4, they will be considered incorrect.
@@ -33,7 +33,7 @@ In this example, the correct answer to the question "What is 2 + 2?" is 4. If th
33
33
34
34
| Property | Type | Description | Defined in |
35
35
| ------ | ------ | ------ | ------ |
36
-
| <aid="acceptablehigh"></a> `acceptableHigh?`|`number`| The acceptable high value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:879](https://github.com/revisit-studies/study/blob/317436dc2065f4bc80347c4bd7250d4444518b6d/src/parser/types.ts#L879)|
37
-
| <aid="acceptablelow"></a> `acceptableLow?`|`number`| The acceptable low value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:877](https://github.com/revisit-studies/study/blob/317436dc2065f4bc80347c4bd7250d4444518b6d/src/parser/types.ts#L877)|
38
-
| <aid="answer"></a> `answer`|`any`| The correct answer to the question. |[parser/types.ts:875](https://github.com/revisit-studies/study/blob/317436dc2065f4bc80347c4bd7250d4444518b6d/src/parser/types.ts#L875)|
39
-
| <aid="id"></a> `id`|`string`| The id of the answer. This is used to identify the answer in the data file. |[parser/types.ts:872](https://github.com/revisit-studies/study/blob/317436dc2065f4bc80347c4bd7250d4444518b6d/src/parser/types.ts#L872)|
36
+
| <aid="acceptablehigh"></a> `acceptableHigh?`|`number`| The acceptable high value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:936](https://github.com/revisit-studies/study/blob/0246def09f8a8d3a9193428f2d57948507c787cd/src/parser/types.ts#L936)|
37
+
| <aid="acceptablelow"></a> `acceptableLow?`|`number`| The acceptable low value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:934](https://github.com/revisit-studies/study/blob/0246def09f8a8d3a9193428f2d57948507c787cd/src/parser/types.ts#L934)|
38
+
| <aid="answer"></a> `answer`|`any`| The correct answer to the question. |[parser/types.ts:932](https://github.com/revisit-studies/study/blob/0246def09f8a8d3a9193428f2d57948507c787cd/src/parser/types.ts#L932)|
39
+
| <aid="id"></a> `id`|`string`| The id of the answer. This is used to identify the answer in the data file. |[parser/types.ts:929](https://github.com/revisit-studies/study/blob/0246def09f8a8d3a9193428f2d57948507c787cd/src/parser/types.ts#L929)|
0 commit comments