From 16880810deff17e663facc6da7ef2142e96ed0b6 Mon Sep 17 00:00:00 2001 From: David Roper Date: Wed, 6 Nov 2024 16:21:50 -0500 Subject: [PATCH 1/5] chore: added record array and optional data type odcumentation --- docs/en/3-guides/3.3-how-to-upload-data.md | 28 ++++++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/en/3-guides/3.3-how-to-upload-data.md b/docs/en/3-guides/3.3-how-to-upload-data.md index 069f20b34..907c6af4b 100644 --- a/docs/en/3-guides/3.3-how-to-upload-data.md +++ b/docs/en/3-guides/3.3-how-to-upload-data.md @@ -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 a data entry for when there can be multiple records for one question. For example, the types of scans and their info in a MRI form. 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 an new entry in the record, whilst every ';' notates and new record in the record array + + - **_Optional Data_** + + Whenever data is optional within a form it can be left empty in a form as still be properly submitted. Any optional data column in the csv template will have an "(optional)" tag attached to its sample data entry, which allows for any entry in the column to 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 a an optional reasonForFailure column. From 0eb1a0a82bae7bb667fbf089b6b7ba0a12c606d2 Mon Sep 17 00:00:00 2001 From: David Roper Date: Wed, 6 Nov 2024 16:31:51 -0500 Subject: [PATCH 2/5] chore: corrections to documentation --- docs/en/3-guides/3.3-how-to-upload-data.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/3-guides/3.3-how-to-upload-data.md b/docs/en/3-guides/3.3-how-to-upload-data.md index 907c6af4b..617418082 100644 --- a/docs/en/3-guides/3.3-how-to-upload-data.md +++ b/docs/en/3-guides/3.3-how-to-upload-data.md @@ -53,18 +53,18 @@ Open Data Capture allows you to visualize numeric measures over time in a single - **_Record Array Data_** - Record array data is a custom form a data entry for when there can be multiple records for one question. For example, the types of scans and their info in a MRI form. 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 data is a custom form a data entry for when there can be multiple records for one column field. For example, the types of scans and their info in a 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 ) + - RECORD_ARRAY(A: dataEntryForA, B: dataEntryForB, C: dataEntryForC ; A: dataEntryForA2, B: dataEntryForB2, C: dataEntryForC2 ;) - Note that every ',' notates an new entry in the record, whilst every ';' notates and new record in the record array + 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 in a form as still be properly submitted. Any optional data column in the csv template will have an "(optional)" tag attached to its sample data entry, which allows for any entry in the column to 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 a an optional reasonForFailure column. + 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 to 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 a an optional reasonForFailure column. From 58e84baab91a79feb2b405a2da07cbc28624615c Mon Sep 17 00:00:00 2001 From: David Roper Date: Thu, 7 Nov 2024 10:36:42 -0500 Subject: [PATCH 3/5] chore: corrections to upload documentation --- docs/en/3-guides/3.3-how-to-upload-data.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/3-guides/3.3-how-to-upload-data.md b/docs/en/3-guides/3.3-how-to-upload-data.md index 617418082..a67dfde72 100644 --- a/docs/en/3-guides/3.3-how-to-upload-data.md +++ b/docs/en/3-guides/3.3-how-to-upload-data.md @@ -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** @@ -65,6 +65,6 @@ Open Data Capture allows you to visualize numeric measures over time in a single - **_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 to 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 a an optional reasonForFailure column. + 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 a an optional reasonForFailure column. From 66d47ca41dccd9899db9ba4adaff48c3eadb5690 Mon Sep 17 00:00:00 2001 From: David Roper <60201980+david-roper@users.noreply.github.com> Date: Thu, 7 Nov 2024 14:34:02 -0500 Subject: [PATCH 4/5] Update docs/en/3-guides/3.3-how-to-upload-data.md Chore: fix typo Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/en/3-guides/3.3-how-to-upload-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/3-guides/3.3-how-to-upload-data.md b/docs/en/3-guides/3.3-how-to-upload-data.md index a67dfde72..8d225d03c 100644 --- a/docs/en/3-guides/3.3-how-to-upload-data.md +++ b/docs/en/3-guides/3.3-how-to-upload-data.md @@ -65,6 +65,6 @@ Open Data Capture allows you to visualize numeric measures over time in a single - **_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 a an optional reasonForFailure column. + 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. From 348aed70fb458706ffefaaf9f8c0017aea749f63 Mon Sep 17 00:00:00 2001 From: David Roper <60201980+david-roper@users.noreply.github.com> Date: Thu, 7 Nov 2024 14:34:43 -0500 Subject: [PATCH 5/5] Update docs/en/3-guides/3.3-how-to-upload-data.md chore: fix wording of record array section Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/en/3-guides/3.3-how-to-upload-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/3-guides/3.3-how-to-upload-data.md b/docs/en/3-guides/3.3-how-to-upload-data.md index 8d225d03c..b349133b3 100644 --- a/docs/en/3-guides/3.3-how-to-upload-data.md +++ b/docs/en/3-guides/3.3-how-to-upload-data.md @@ -53,7 +53,7 @@ Open Data Capture allows you to visualize numeric measures over time in a single - **_Record Array Data_** - Record array data is a custom form a data entry for when there can be multiple records for one column field. For example, the types of scans and their info in a 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 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 ;)