Skip to content

Commit

Permalink
Merge pull request #1033 from david-roper/record-array-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshunrau authored Nov 12, 2024
2 parents 99dc341 + 348aed7 commit 21b6bd0
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions docs/en/3-guides/3.3-how-to-upload-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Open Data Capture allows you to visualize numeric measures over time in a single

3. **Select the Upload tab**

Select the upload tab within the side navigation bar. This will reveal a page displaying all the Form instruments that are available in the current OpenDataCapture instance.
Select the upload tab within the side navigation bar. This will reveal a page displaying all the form instruments that are available in the current OpenDataCapture instance.

4. **Select Instrument to Upload to**

Expand All @@ -41,12 +41,30 @@ Open Data Capture allows you to visualize numeric measures over time in a single

Some forms may have Zod field types that are challenging to represent in a standard CSV format. Therefore, specific notations must be used to ensure the upload feature can properly parse the data.

For example: If a form has a field that accepts a set of data, such as a multi-option checklist with options a, b, and c, the proper notation for the data would be:
- **_Set Data_**

- SET(a,b)
- SET(a,b,c)
- SET(a)
If a form has a field that accepts a set of data, such as a multi-option checklist with options a, b, and c, the proper notation for the data would be:

This format allows the upload feature to correctly interpret the selected options.
- SET(a,b)
- SET(a,b,c)
- SET(a)

This format allows the upload feature to correctly interpret the selected options.

- **_Record Array Data_**

Record array data is a custom form of data entry for when there can be multiple records for one column field. For example, the types of scans and their info in an MRI form would be record array data. If a record contains a set of questions/ data fields A, B, and C, the proper notation for data entry would be as follows:

- RECORD_ARRAY(A: dataEntryForA, B: dataEntryForB, C: dataEntryForC ;)

If the record array question contains multiple records the data entry would look like so:

- RECORD_ARRAY(A: dataEntryForA, B: dataEntryForB, C: dataEntryForC ; A: dataEntryForA2, B: dataEntryForB2, C: dataEntryForC2 ;)

Note that every "," notates a new entry in the record, whilst every ";" notates a new record in the record array

- **_Optional Data_**

Whenever data is optional within a form it can be left empty and still be properly submitted. Any optional data column in the csv template will have an "(optional)" tag attached to its sample data entry, which means any entry in the column can be left blank. This is usually done in that case of when one column value depends on another. For example, a sessionFailed column would be followed by an optional reasonForFailure column.

</Steps>

0 comments on commit 21b6bd0

Please sign in to comment.