Export Layouts¶
The YES3 Exporter II currently supports two export layouts: Vertical(v) and Horizontal(h).
For all export layouts the first field or 'variable' in the exported record will be the recordid, and the variable name will be the recordid field name as defined for the specific project.
Depending on the layout and study design, the recordid variable may be followed by a collection of "REDCap Attribute" variables that indicate the REDCap data access group and event.
The remainder of the exported record is the collection of values for the selected fields, in the order specified. The variable name of each will be either the REDCap field name (vertical layouts), or a composite of the REDCap event prefix and the REDCap field name (horizontal layout).
Following are more detailed descriptions of the export layouts.
The Vertical Export Layout¶
For classic (cross sectional) study designs, the vertical export layout has one row for each record. For longitudinal study designs, the vertical export layout has one row per observed record and event combination.
For a longitudinal study, a vertical layout record will be exported only for events for which data are observed for the record. No empty records will be exported.
Export record specification for a Vertical layout¶
| variable | description | comments |
|---|---|---|
| [recordId] | The record unique identifier | study-specific variable name |
| redcap_data_access_group_id | The numeric DAG id | only present if DAGs are assigned to records |
| redcap_data_access_group_name | The unique DAG name | only present if DAGs are assigned to records |
| redcap_event_id | The numeric event id | only present for longitudinal studies |
| redcap_event_name | The unique REDCap event name | only present for longitudinal studies |
| redcap_repeat_instance | The form or event instance (1+) | Present if any repeating forms or events are included in the export |
| [fieldname] | the first selected field value | variable name is the underlying REDCap field name |
| ... | ||
| [fieldname] | the last selected field value | variable name is the underlying REDCap field name |
The Horizontal Export Layout¶
Horizontal layouts are allowed only for longitudinal study designs, and have one row for each record.
A horizontal layout record will have one variable per specified REDCap field and event combination. This can lead to exported datasets having enormous column counts and many empty cells. In general, vertical layouts are more efficient than horizontal layouts. However, for most studies horizontal layouts have the advantage of having one row per analysis unit (record), and are therefore "analysis ready" in many contexts.
Export record specification for a Horizontal layout¶
| variable | description | comments |
|---|---|---|
| [recordId] | The record unique identifier | study-specific variable name |
| redcap_data_access_group_id | The numeric DAG id | only present if DAGs are assigned to records |
| redcap_data_access_group_name | The unique DAG name | only present if DAGs are assigned to records |
| redcap_repeat_instance | The form or event instance (1+) | Present if any repeating forms or events are included in the export |
| [composite fieldname] | the first selected field/event value | variable name is [event prefix]_[ REDCap field name] |
| ... | ||
| [composite fieldname] | the last selected field/event value | variable name is [event prefix]_[ REDCap field name] |