diff --git a/public/demo-VLAT-full-randomized/config.json b/public/demo-VLAT-full-randomized/config.json index bc481a2f7..f74390a0a 100644 --- a/public/demo-VLAT-full-randomized/config.json +++ b/public/demo-VLAT-full-randomized/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Randomized Full VLAT (Visualization Literacy Assessment Test)", "version": "pilot", diff --git a/public/demo-VLAT-mini-randomized/config.json b/public/demo-VLAT-mini-randomized/config.json index b58555165..a156eb80a 100644 --- a/public/demo-VLAT-mini-randomized/config.json +++ b/public/demo-VLAT-mini-randomized/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Visualization understanding questionnaire", "version": "pilot", diff --git a/public/demo-brush-interactions/config.json b/public/demo-brush-interactions/config.json index cda06f325..2fb490887 100644 --- a/public/demo-brush-interactions/config.json +++ b/public/demo-brush-interactions/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Interactive Selections in Scatterplots", "version": "pilot", diff --git a/public/demo-cleveland/config.json b/public/demo-cleveland/config.json index 1d7784c7e..4c06dc116 100644 --- a/public/demo-cleveland/config.json +++ b/public/demo-cleveland/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Dynamic React.js Stimuli: A Graphical Perception Experiment", "version": "pilot", diff --git a/public/demo-click-accuracy-test/config.json b/public/demo-click-accuracy-test/config.json index 519c371bf..1edfc0f01 100644 --- a/public/demo-click-accuracy-test/config.json +++ b/public/demo-click-accuracy-test/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Dynamic React Stimuli and Provenance Tracking", "version": "pilot", diff --git a/public/demo-fairness-jnd/config.json b/public/demo-fairness-jnd/config.json index f5149a4a4..6aec83005 100644 --- a/public/demo-fairness-jnd/config.json +++ b/public/demo-fairness-jnd/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Fairness JND", "version": "pilot", diff --git a/public/demo-html-input/config.json b/public/demo-html-input/config.json index 5ac031f40..5ea9b5a21 100644 --- a/public/demo-html-input/config.json +++ b/public/demo-html-input/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Passing Data from reVISit to HTML and back", "version": "pilot", diff --git a/public/demo-html-trrack/config.json b/public/demo-html-trrack/config.json index 1936f87de..f36466a44 100644 --- a/public/demo-html-trrack/config.json +++ b/public/demo-html-trrack/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "HTML with Trrack library", "version": "pilot", diff --git a/public/demo-html/config.json b/public/demo-html/config.json index 3e21da98d..ff32d5f64 100644 --- a/public/demo-html/config.json +++ b/public/demo-html/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "HTML as a Stimulus", "version": "pilot", diff --git a/public/demo-image/config.json b/public/demo-image/config.json index e10e7d1c2..27733e637 100644 --- a/public/demo-image/config.json +++ b/public/demo-image/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Simple Images as Stimuli: Decision-Making with Uncertainty Visualizations", "version": "pilot", diff --git a/public/demo-mvnv/config.json b/public/demo-mvnv/config.json index ee187d79f..bf1c1679a 100644 --- a/public/demo-mvnv/config.json +++ b/public/demo-mvnv/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "MVNV Study Replication", "version": "pilot", diff --git a/public/demo-survey/config.json b/public/demo-survey/config.json index 1c5b8917b..0ed5bd819 100644 --- a/public/demo-survey/config.json +++ b/public/demo-survey/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Question Types and Form Elements Demo", "version": "pilot", diff --git a/public/global.json b/public/global.json index 441e4a2bc..093f653b0 100644 --- a/public/global.json +++ b/public/global.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/GlobalConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/GlobalConfigSchema.json", "configsList": [ "demo-html", "demo-cleveland", diff --git a/public/test-parser-errors/config.json b/public/test-parser-errors/config.json index e05e995a6..149decc6a 100644 --- a/public/test-parser-errors/config.json +++ b/public/test-parser-errors/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Test for parser errors", "version": "pilot", diff --git a/public/test-randomization/config.json b/public/test-randomization/config.json index 641a13fe5..6f8c45cba 100644 --- a/public/test-randomization/config.json +++ b/public/test-randomization/config.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { "title": "Using Randomization", "description": "This is a test study to check the functionality of the reVISit sequence generator. This study is not meant to be used for any real data collection.", diff --git a/src/parser/StudyConfigSchema.json b/src/parser/StudyConfigSchema.json index a39c161f3..9ef469bc6 100644 --- a/src/parser/StudyConfigSchema.json +++ b/src/parser/StudyConfigSchema.json @@ -1123,7 +1123,7 @@ }, "ReactComponent": { "additionalProperties": false, - "description": "The ReactComponent interface is used to define the properties of a react component. This component is used to render react code with certain parameters. These parameters can be used within your react code to render different things.\n\nUnlike other types of components, the path for a React component is relative to the `src/public/` folder. Similar to our standard assets, we suggest creating a folder named `src/public/{studyName}/assets` to house all of the React component assets for a particular study. Your React component which you link to in the path must be default exported from its file.\n\nReact components created this way have a generic prop type passed to the component on render, `>`, which has the following types.\n\n```ts { parameters: T; setAnswer: ({ status, provenanceGraph, answers }: { status: boolean, provenanceGraph?: TrrackedProvenance, answers: Record }) => void } ```\n\nparameters is the same object passed in from the ReactComponent type below, allowing you to pass options in from the config to your component. setAnswer is a callback function allowing the creator of the ReactComponent to programmatically set the answer, as well as the provenance graph. This can be useful if you don't use the default answer interface, and instead have something more unique.\n\nSo, for example, if I had the following ReactComponent in my config ```js { type: 'react-component'; path: 'my_study/CoolComponent.tsx'; parameters: { name: 'Zach'; age: 26; } } ```\n\nMy react component, CoolComponent.tsx, would exist in src/public/my_study/assets, and look something like this\n\n```ts export default function CoolComponent({ parameters, setAnswer }: StimulusParams<{name: string, age: number}>) { // render something } ```\n\nFor in depth examples, see the following studies, and their associated codebases. https://revisit.dev/study/demo-click-accuracy-test (https://github.com/revisit-studies/study/tree/v1.0.0-beta16/src/public/demo-click-accuracy-test/assets) https://revisit.dev/study/demo-brush-interactions (https://github.com/revisit-studies/study/tree/v1.0.0-beta16/src/public/demo-brush-interactions/assets)", + "description": "The ReactComponent interface is used to define the properties of a react component. This component is used to render react code with certain parameters. These parameters can be used within your react code to render different things.\n\nUnlike other types of components, the path for a React component is relative to the `src/public/` folder. Similar to our standard assets, we suggest creating a folder named `src/public/{studyName}/assets` to house all of the React component assets for a particular study. Your React component which you link to in the path must be default exported from its file.\n\nReact components created this way have a generic prop type passed to the component on render, `>`, which has the following types.\n\n```ts { parameters: T; setAnswer: ({ status, provenanceGraph, answers }: { status: boolean, provenanceGraph?: TrrackedProvenance, answers: Record }) => void } ```\n\nparameters is the same object passed in from the ReactComponent type below, allowing you to pass options in from the config to your component. setAnswer is a callback function allowing the creator of the ReactComponent to programmatically set the answer, as well as the provenance graph. This can be useful if you don't use the default answer interface, and instead have something more unique.\n\nSo, for example, if I had the following ReactComponent in my config ```js { type: 'react-component'; path: 'my_study/CoolComponent.tsx'; parameters: { name: 'Zach'; age: 26; } } ```\n\nMy react component, CoolComponent.tsx, would exist in src/public/my_study/assets, and look something like this\n\n```ts export default function CoolComponent({ parameters, setAnswer }: StimulusParams<{name: string, age: number}>) { // render something } ```\n\nFor in depth examples, see the following studies, and their associated codebases. https://revisit.dev/study/demo-click-accuracy-test (https://github.com/revisit-studies/study/tree/v1.0.0/src/public/demo-click-accuracy-test/assets) https://revisit.dev/study/demo-brush-interactions (https://github.com/revisit-studies/study/tree/v1.0.0/src/public/demo-brush-interactions/assets)", "properties": { "correctAnswer": { "description": "The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.", @@ -1424,7 +1424,7 @@ }, "StudyConfig": { "additionalProperties": false, - "description": "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. Below is the general template that should be followed when constructing a Study configuration file.\n\n```js { \"$schema\": \"https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json\", \"studyMetadata\": { ... }, \"uiConfig\": { ... }, \"components\": { ... }, \"sequence\": { ... } } ```\n\n:::info For information about each of the individual pieces of the study configuration file, you can visit the documentation for each one individually. :::
\n\nThe `$schema` line is used to verify the schema. If you're using VSCode (or other similar IDEs), including this line will allow for autocomplete and helpful suggestions when writing the study configuration.", + "description": "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. Below is the general template that should be followed when constructing a Study configuration file.\n\n```js { \"$schema\": \"https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json\", \"studyMetadata\": { ... }, \"uiConfig\": { ... }, \"components\": { ... }, \"sequence\": { ... } } ```\n\n:::info For information about each of the individual pieces of the study configuration file, you can visit the documentation for each one individually. :::
\n\nThe `$schema` line is used to verify the schema. If you're using VSCode (or other similar IDEs), including this line will allow for autocomplete and helpful suggestions when writing the study configuration.", "properties": { "$schema": { "description": "A required json schema property. This should point to the github link for the version of the schema you would like. The `$schema` line is used to verify the schema. If you're using VSCode (or other similar IDEs), including this line will allow for autocomplete and helpful suggestions when writing the study configuration. See examples for more information", diff --git a/src/parser/types.ts b/src/parser/types.ts index f0a4ab2c3..0d30288ae 100644 --- a/src/parser/types.ts +++ b/src/parser/types.ts @@ -562,8 +562,8 @@ export default function CoolComponent({ parameters, setAnswer }: StimulusParams< ``` * * For in depth examples, see the following studies, and their associated codebases. - * https://revisit.dev/study/demo-click-accuracy-test (https://github.com/revisit-studies/study/tree/v1.0.0-beta16/src/public/demo-click-accuracy-test/assets) - * https://revisit.dev/study/demo-brush-interactions (https://github.com/revisit-studies/study/tree/v1.0.0-beta16/src/public/demo-brush-interactions/assets) + * https://revisit.dev/study/demo-click-accuracy-test (https://github.com/revisit-studies/study/tree/v1.0.0/src/public/demo-click-accuracy-test/assets) + * https://revisit.dev/study/demo-brush-interactions (https://github.com/revisit-studies/study/tree/v1.0.0/src/public/demo-brush-interactions/assets) */ export interface ReactComponent extends BaseIndividualComponent { type: 'react-component'; @@ -1154,7 +1154,7 @@ export type BaseComponents = Record>; ```js { - "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0-beta16/src/parser/StudyConfigSchema.json", + "$schema": "https://raw.githubusercontent.com/revisit-studies/study/v1.0.0/src/parser/StudyConfigSchema.json", "studyMetadata": { ... },