jsPsych/docs/markdown_docs/plugins/jspsych-survey-text.md
Wolfgang Walther 8512bee22c Docs: jspsych-survey plugins fixes
Leftover from survey-text in survey-multi-choice
Grammar (responses / response)
2016-10-23 18:19:45 +02:00

47 lines
2.2 KiB
Markdown

# jspsych-survey-text plugin
The survey-text plugin displays a set of questions with free response text fields. The subject types in answers.
## Parameters
This table lists the parameters associated with this plugin. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
Parameter | Type | Default Value | Description
----------|------|---------------|------------
questions | array | *undefined* | An array of strings. The strings are the prompts for the subject to respond to. Each string gets its own response field.
preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
rows | array | 1 | The number of rows for the response text box. Array length must match `questions` array, with a numeric value for each entry indicating the number of rows for that question's box.
columns | array | 40 | The number of columns for the response text box. Array length must match `questions` array, with a numeric value for each entry indicating the number of columns for that question's box.
## Data Generated
In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), this plugin collects the following data for each trial.
Name | Type | Value
-----|------|------
responses | JSON string | A string in JSON format containing the response for each question. The encoded object will have a separate variable for the response to each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. Each response is a string containing whatever the subject typed into the associated text box.
rt | numeric | The response time in milliseconds for the subject to make a response.
## Examples
### Basic example
```javascript
// defining groups of questions that will go together.
var survey_trial = {
type: 'survey-text',
questions: ["How old are you?", "Where were you born?"],
};
```
### Custom number of rows and columns
```javascript
var survey_trial = {
type: 'survey-text',
questions: ["How old are you?", "Where were you born?"],
rows: [5,3],
columns: [40,50]
};
```