Skip to content

Commit d1da7a1

Browse files
committed
chore: add sample table and example valid entries for it
1 parent 952d92a commit d1da7a1

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

docs/en/3-guides/3.3-how-to-upload-data.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,34 @@ Open Data Capture allows you to visualize numeric measures over time in a single
7171

7272
### Sample CSV Data
7373

74-
This section will present how to properly fill in a template csv from the upload feature. Say we download the following csv template that looks like this below.
74+
This section will present how to properly fill in a template csv from the upload feature. Say we download the following csv template that looks like this below:
7575

7676
| subjectID | date | stringQuestion | setQuestion | optionalQuestion | recordArrayQuestion |
7777
| :-------- | :--------- | :------------- | :-------------- | :--------------- | :--------------------------------------------------- |
7878
| string | yyyy-mm-dd | yes/no | SET(A/B/C, ...) | A/B (optional) | RECORD_ARRAY(testString: A/B/C, testNumber: number;) |
79+
| | | | | | |
80+
81+
<br>
82+
83+
Starting with the first column we have **subjectID**, which is a string value contain the identification of the subject taking part in the instrument. This field is required.
84+
85+
The second column contains the date of which in instrument was done by the subject, which follows _yyyy-mm-dd_ format. This field is to be filled for each row.
86+
87+
The third column is a string entry consisting of two possible options (yes/no)
88+
89+
The fourth column is a field which takes in a set of entries, where the options for entry are A, B or C. A set can have all these option within it however it does not accept duplicates. So an entry such as SET(A,A,C) would fail, but the entry SET(A,B,C) would be valid.
90+
91+
The fifth column is an option string field, containing the options of A or B. This field can either contain A, B or can remain empty.
92+
93+
Finally the sixth column is a record array field, a record array object can be entered with it with the corresponding fields testString and testNumber. A record array can also have multiple entries of the field within it, as long as the new entry is separated by a **";"**. Valid entries would be RECORD_ARRAY(testString: A, testNumber: 1;) or RECORD_ARRAY(testString: A, testNumber: 1; testString: 1, testNumber: 2;), etc.
94+
95+
<br>
96+
97+
A valid CSV file that follows this template can be seen below:
98+
99+
| subjectID | date | stringQuestion | setQuestion | optionalQuestion | recordArrayQuestion |
100+
| :-------- | :--------- | :------------- | :---------- | :--------------- | :-------------------------------------------------------------------------- |
101+
| testID123 | 2025-01-07 | yes | SET(A, B) | B | RECORD_ARRAY(testString: A, testNumber: 2; testString: B, testNumber: 3;) |
102+
| testID111 | 2025-01-06 | no | SET(C, B) | A | RECORD_ARRAY(testString: B, testNumber: 22; testString: A, testNumber: 1;) |
103+
| testID111 | 2025-01-03 | no | SET(A, C) | | RECORD_ARRAY(testString: B, testNumber: 12; testString: B, testNumber: 13;) |
104+
| ... | ... | ... | ... | ... | ... |

0 commit comments

Comments
 (0)