Page History: Reporter Element
Compare Page Revisions
Page Revision: 2013/06/10 06:38
|
Reporter
|
Info |
Category: |
Scenario Control |
|
AddIn: |
Base Elements |
Creator: |
OkazoLab Team |
|
Scope: |
Parent Event |
Owns Snippets: |
no |
|
Usage: |
Runtime Screen,Snippets |
The Reporter element offers a simple and flexible way to control data collection in EventIDE experiments.
Description
EventIDE has an core mechanism for data collection, which is called
Data Report. The mechanism is very flexible, because you can always code what data will be written and when it will be done in the course of an experiment. To remove a need to write such data collection code in standard scenarios, the Reporter element is introduced. The element provides a visual designer, where you can select a list of
global variables and
Proxy Variables for recording. With the Reporter's designer you can define the variable order, value formats and preview the expected results.
At runtime, the Reporter element automatically makes a snapshot of the selected variables, builds a text block with collected variables' values (either in a line or columns) and records the block into the Data Report. This operation is done either on onset or on offset the parent event, which helps to implement repeated data drops, when the parent event is included in a trial loop.
Multiple Reporter elements can be used elsewhere in an experiment, when different blocks of the data have to be recorded separately. The element can also create a header line containing names of the selected variables. The header is automatically placed at the top of the data report, before actual data collection starts.
Snapshots
Snapshot 1
| Snapshot 2 |
Practical Use
Using Reporter for collecting trial data into a multi-line table
- Check a logic of your experiment to choose variables whose values you want to collect in each trial.
- Add the Reporter element to the event, in which you want to collect data. Typically, it is the last event in a trial loop.
- Set the Recording Point property of Reporter. You can define there when data will be collected, either on onset or offset of the parent event. The default option is the event
offset, because you may need to calculate a trial outcome, after onset of the last trial event but before trial data is recorded. - Open the Reporter designer by clicking on the corresponding property.
- Using a drop-down list on the left-top of the designer, select and add all variables whose values you want to record in each trial:
{|
| Dropdown selection of variables
|} - In the Layout Option panel set the layout of variables to "in rows" and choose a character that will be used a column separator.
- Check the report preview at the bottom of the designer
- Close the designer and run an experiment for several trial loops.
- Open or export the resulting data report, and check how trial data is recorded. You should see data organized in a table, for example:
Participant Code;Block Number;Trial Number;Target Position;Target Color;Target Shape;SOA Duration;Trial Result;Trial RT;
Participant 01;1;1;180;Blue;1;100;True;881;
Participant 01;1;2;180;Yellow;2;400;True;564;
Participant 01;1;3;180;Blue;2;300;False;0;
Participant 01;1;4;0;Blue;2;600;True;867;
Participant 01;1;5;180;Red;2;200;True;760;
Using Reporter for collecting data into a record list
- Repeat steps 1-5 from the previous technique except for selection of the parent event. The record list is usually added once per run, at the start of the experiment.
- Set the layout of variables to "in columns" in the Layout Option panel of Reporter's designer. If you do not want variables' names to be included in a record list, uncheck the 'Append variables's headers' option.
- Set the layout of variables to "in columns" in the Layout Option panel of Reporter's designer. If you do not want variables' names to be included in a record list, uncheck the 'Append variables's headers' option. Otherwise, select a character that will separate variable's name and value in each row.
- Check the report preview at the bottom of the designer
- Close the designer and run an experiment for several trial loops.
- Open or export the resulting data report, and check how trial data is recorded. You should see data organized in a list, for example:
Participant Code;Participant 01;
Condition; AA05;
Key Map; 01;
Element's internal actions aligned with epochs of the parent event
Epoche | Actions |
---|
After onset | if the Recording Point property is 'On Onset', Reporter saves selected variables into a data report |
Before offset | if the Recording Point property is 'On Offset', Reporter saves selected variables into a data report |
Notes
- You can use multiple Reporter elements elsewhere in an experiment, but be aware of the order, in which they save their own data into a data report.
- There is no need to use Reporter, when you need to save a list of global experiment variables at the top of a data report, you can used the startup info variables instead.
- While using the Reporter element, you still can write any data into a data report directly, via code snippets.
- You can temporally suspend data collection done by Reporter. To do it set its 'Is Active' property to False at runtime.
Properties
Generic Properties
Name | Description | Attributes | Value Type | Proxy Reflex |
---|
Settings |
Recording Point | Defines a time point in the parent event, where the element records selected variables into Data Report | | Option List |
Report Designer | Opens a visual designer for data collection | |
Runtime Control |
Is Active | Defines whether Reporter is in a working state. Set the value to false to suspend data recording. | | Boolean |
+=== Properties inherited from clElement ===
Inherited properties of clElement
Name | Description | Constraints | Value Type | Upon Change |
---|
Control |
Is Enabled | If set to false the element is completely omitted when the experiment is run. | | Boolean |
|
Title | Title of the element. | | String |
|