Skip to content

Commit

Permalink
fix and complete documentation for all plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
jadeddelta committed Oct 19, 2024
1 parent a13c8fd commit 132c1f5
Show file tree
Hide file tree
Showing 74 changed files with 320 additions and 267 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ The `/packages` directory also contains four template sub-folders that can be us
[libet-intentional-binding](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-libet-intentional-binding/README.md) | [Isaac Kinley](https://github.com/kinleyid) | This plugin measures intentional binding using a Libet clock, and allows the participant to estimate the timing of events by adjusting the clock hand themselves.
[nextcloud-filedrop](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-nextcloud-filedrop/README.md) | [C. Martin Grewe](https://github.com/mgrewe) | This plugin provides permanent storage of data collected during an experiment using a nextcloud instance.
[pipe](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-pipe/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | jsPsych plugin to faciliate communication with [DataPipe](https://pipe.jspsych.org)
[rdk](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-rdk/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | This plugin displays a Random Dot Kinematogram (RDK) and allows the subject to report the primary direction of motion by pressing a key on the keyboard.
[rok](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-rok/README.md) | [Younes Strittmatter](https://github.com/younesStrittmatter) | This plugin displays a Random Object Kinematogram (ROK) and allows the subject to report the primary direction of motion or the primary orientation by pressing a key on the keyboard.
[rdk](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-rdk/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | This plugin displays a Random Dot Kinematogram (RDK) and allows the participant to report the primary direction of motion by pressing a key on the keyboard.
[rok](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-rok/README.md) | [Younes Strittmatter](https://github.com/younesStrittmatter) | This plugin displays a Random Object Kinematogram (ROK) and allows the participant to report the primary direction of motion or the primary orientation by pressing a key on the keyboard.
[self-paced-reading](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-self-paced-reading/README.md) | [igmmgi](https://github.com/igmmgi) | Self-paced reading tasks with different display options.
[survey-number](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-survey-number/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | This plugin displays a survey question and collects a numeric response.
[survey-slider](https://github.com/jspsych/jspsych-contrib/blob/main/packages/@jspsych-contrib/plugin-survey-slider/README.md) | [Dominique Makowski](https://github.com/DominiqueMakowski) | Add several analogue scales on the same page for use in questionnaires.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Data Generated

In addition to the [default data collected by all plugins](https://www.jspsych.org/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects the following data for each trial.

| Name | Type | Value |
| --------- | ----------- | ---------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion packages/extension-mediapipe-face-mesh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ record | boolean | false | Should the data generated as described below recorded

### Data Generated

In addition to the [default data collected by all plugins](https://www.jspsych.org/overview/plugins#data-collected-by-all-plugins), this plugin collects all parameter data described above and the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects all parameter data described above and the following data for each trial.

| Name | Type | Value |
| ---------------- | ----------- | ---------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# touchscreen-buttons extension

This extension displays touch buttons allows the subject to respond to stimuli via touchscreen on mobile devices. The
This extension displays touch buttons allows the participant to respond to stimuli via touchscreen on mobile devices. The
touch button send key press events so that all jsPsych plugins that use keyboard input are compatible.

## Citation
Expand Down
2 changes: 1 addition & 1 deletion packages/extension-touchscreen-buttons/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

This extension displays touch buttons that allow the subject to respond to stimuli via a touchscreen on mobile devices. The touch button sends key press events so that all jsPsych plugins that use keyboard input are compatible.
This extension displays touch buttons that allow the participant to respond to stimuli via a touchscreen on mobile devices. The touch button sends key press events so that all jsPsych plugins that use keyboard input are compatible.


## Loading
Expand Down
6 changes: 3 additions & 3 deletions packages/plugin-audio-multi-response/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Overview

This plugin plays an audio file and records responses generated by both button click and the keyboard. Allowing multiple response modalities is useful when designing assessments that will be administered on both desktop and mobile (e.g., phone or tablet) devices. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time.
This plugin plays an audio file and records responses generated by both button click and the keyboard. Allowing multiple response modalities is useful when designing assessments that will be administered on both desktop and mobile (e.g., phone or tablet) devices. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the participant has failed to respond within a fixed length of time.

If the browser supports it, audio files are played using the WebAudio API. This allows for reasonably precise timing of the playback. The timing of responses generated is measured against the WebAudio specific clock, improving the measurement of response times. If the browser does not support the WebAudio API, then the audio file is played with HTML5 audio.

Audio files can be automatically preloaded by jsPsych using the preload plugin. However, if you are using timeline variables or another dynamic method to specify the audio stimulus, then you will need to manually preload the audio.

The trial can end when the subject responds, when the audio file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a response from being recorded before the audio has finished playing.
The trial can end when the participant responds, when the audio file has finished playing, or if the participant has failed to respond within a fixed length of time. You can also prevent a response from being recorded before the audio has finished playing.

## Loading

Expand All @@ -18,7 +18,7 @@ The trial can end when the subject responds, when the audio file has finished pl

## Compatibility

jsPsych v7.0
jsPsych v8.0. For compatibility with jsPsych v7.0, use version 1.0.0 of this plugin.

## Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The trial can end when the participant responds, when the audio file has finishe

## Parameters

In addition to the [parameters available in all plugins](https://www.jspsych.org/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.
In addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins/#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.

| Parameter | Type | Default Value | Description |
| ----------|------|---------------|------------ |
Expand All @@ -29,7 +29,7 @@ In addition to the [parameters available in all plugins](https://www.jspsych.org

## Data Generated

In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects the following data for each trial.

| Name | Type | Value |
| --------- | ------- | ---------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-audio-multi-response/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const info = <const>{
default: [],
array: true,
},
/** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
/** Array containing the key(s) the participant is allowed to press to respond to the stimulus. */
keyboard_choices: {
type: ParameterType.KEYS,
pretty_name: "Keyboard Choices",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-audio-swipe-response/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The trial can end when the participant responds, when the audio file has finishe

## Compatibility

jsPsych v7.0
jsPsych v8.0. For compatibility with jsPsych v7.0, use version 1.0.0 of this plugin.

## Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The trial can end when the participant responds, when the audio file has finishe

## Parameters

In addition to the [parameters available in all plugins](https://www.jspsych.org/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.
In addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins/#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.

| Parameter | Type | Default Value | Description |
| ----------|------|---------------|------------ |
Expand All @@ -28,7 +28,7 @@ In addition to the [parameters available in all plugins](https://www.jspsych.org

## Data Generated

In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects the following data for each trial.

| Name | Type | Value |
| --------- | ------- | ---------------------------------------- |
Expand Down
7 changes: 3 additions & 4 deletions packages/plugin-copying-task/docs/jspsych-copying-task.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# jspsych-copying-task plugin

This plugin runs a copying task. In a trial, an example grid (the "model", containing various stimuli) on the left must replicated in the middle grid (the "workspace"). To do this stimuli from the right grid (the "resources") can be picked up and dragged to the middle grid. You can use imgage files (e.g., .jpg/.png/.gif) as stimuli, or built in 'nonsense' shape stimuli in any color. The plugin records the actions of the participant what items are picked up and where they are placed.
This plugin runs a copying task. In a trial, an example grid (the "model", containing various stimuli) on the left must replicated in the middle grid (the "workspace"). To do this stimuli from the right grid (the "resources") can be picked up and dragged to the middle grid. You can use image files (e.g., .jpg/.png/.gif) as stimuli, or built in 'nonsense' shape stimuli in any color. The plugin records the actions of the participant what items are picked up and where they are placed.

## Parameters

Parameters can be left unspecified if the default value is acceptable. If more then one aperture is displayed most of the parameters should be specified as array (specified by the array column).
The elements of the array then apply to the corresponding aperture. Features that are not fully implemented yet are marked with an x
Parameters can be left unspecified if the default value is acceptable. If more then one aperture is displayed most of the parameters should be specified as array (specified by the array column). The elements of the array then apply to the corresponding aperture. So in addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins/#parameters-available-in-all-plugins), this plugin accepts the following parameters.

|Parameter|Type|Default Value| Descripton|
|---------|----|-------------|-----------|
Expand All @@ -29,7 +28,7 @@ The elements of the array then apply to the corresponding aperture. Features tha

## Data Generated

In addition to the default data collected by all plugins, this plugin collects all parameter data described above and the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects all parameter data described above and the following data for each trial.

|Name|Type|Description|
|----|----|-----------|
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-corsi-blocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import jsPsychCorsiBlocks from '@jspsych-contrib/plugin-corsi-blocks';

## Compatibility

jsPsych 7.3.2.
jsPsych v8.0. For compatibility with jsPsych v7.3.2, use version 1.0.0 of this plugin.

(Earlier versions of jsPsych version 7 will work if you explicitly set the `blocks` parameter in a trial. Using the default `blocks` parameter requires `7.3.2` or later.)

Expand Down
14 changes: 7 additions & 7 deletions packages/plugin-corsi-blocks/docs/jspsych-corsi-blocks.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# jspsych-corsi-blocks plugin

This plugin displays a sequence of blocks and then gets the subject's response. The sequence can be displayed in either 'display' mode or 'input' mode. In 'display' mode, the sequence is displayed and the trial ends after the sequence is complete. In 'input' mode, the subject must click on the blocks in the correct order.
This plugin displays a sequence of blocks and then gets the participant's response. The sequence can be displayed in either 'display' mode or 'input' mode. In 'display' mode, the sequence is displayed and the trial ends after the sequence is complete. In 'input' mode, the participant must click on the blocks in the correct order.

## Parameters

In addition to the [parameters available in all plugins](https://www.jspsych.org/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.
In addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins/#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.

| Parameter | Type | Default Value | Description |
| ----------|------|---------------|------------ |
Expand All @@ -26,19 +26,19 @@ In addition to the [parameters available in all plugins](https://www.jspsych.org

## Data Generated

In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects the following data for each trial.

| Name | Type | Value |
| --------- | ------- | ---------------------------------------- |
| sequence | array | The sequence of block indexes that was displayed. |
| response | array | The sequence of block indexes that was selected by the subject. |
| correct | boolean | Whether the subject's response was correct. |
| rt | array | The time, in milliseconds, that the subject took to respond to each block. These times are cumulative, measured from the onset of the display. |
| response | array | The sequence of block indexes that was selected by the participant. |
| correct | boolean | Whether the participant's response was correct. |
| rt | array | The time, in milliseconds, that the participant took to respond to each block. These times are cumulative, measured from the onset of the display. |
| blocks | array | The coordinates of the blocks that were displayed. |

## Examples

### Displaying a two-item sequence and then getting the subject's response.
### Displaying a two-item sequence and then getting the participant's response.

```javascript
const show_sequence = {
Expand Down
4 changes: 2 additions & 2 deletions packages/plugin-corsi-blocks/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,10 @@ type Info = typeof info;
* **corsi-blocks**
*
* This plugin displays a sequence of blocks and then gets the
* subject's response. The sequence can be displayed in either
* participant's response. The sequence can be displayed in either
* 'display' mode or 'input' mode. In 'display' mode, the
* sequence is displayed and the trial ends after the sequence
* is complete. In 'input' mode, the subject must click on the
* is complete. In 'input' mode, the participant must click on the
* blocks in the correct order.
*
* @author Josh de Leeuw
Expand Down
6 changes: 3 additions & 3 deletions packages/plugin-gamepad/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This is a plugin that allows one to use gamepads in a jsPsych experiment. Curren

## Compatibility

jsPsych >= 7.0
jsPsych v8.0. For compatibility with jsPsych v7.0, use version 1.0.1 of this plugin.

## Parameters

In addition to the [parameters available in all plugins](https://www.jspsych.org/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.
In addition to the [parameters available in all plugins](https://www.jspsych.org/latest/overview/plugins/#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.

| Parameter | Type | Default Value | Description |
| --------- | ---- | ------------- | ----------- |
Expand All @@ -23,7 +23,7 @@ In addition to the [parameters available in all plugins](https://www.jspsych.org

## Data Generated

In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.
In addition to the [default data collected by all plugins](https://www.jspsych.org/latest/overview/plugins/#data-collected-by-all-plugins), this plugin collects the following data for each trial.

| Name | Type | Value |
| --------- | ------- | ---------------------------------------- |
Expand Down
Loading

0 comments on commit 132c1f5

Please sign in to comment.