From 89d500e7de84e4b13ae29634d39d4628b20a0578 Mon Sep 17 00:00:00 2001
From: Anastasia Diseth <58883418+anadis504@users.noreply.github.com>
Date: Sat, 1 Jun 2024 13:01:30 +0300
Subject: [PATCH] Update README.md
---
data-parser/README.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/data-parser/README.md b/data-parser/README.md
index ca1623d..320549b 100644
--- a/data-parser/README.md
+++ b/data-parser/README.md
@@ -26,6 +26,9 @@ The output of the data-parser is a .csv file containing only answers to the `DOG
The file contains columns `user_id, name, email`, followed by a column per `questionLabel` existing in the course. Empty submissions (not answered questions) have empty entry-points.
+Additionally, column `course_module_name` specify which module the answers for the given user belong to.
+Columns `exercise_name` __per exercise__ (that may contain several _exercise tasks_) with a timestamp for when the user completed the given exercise.
+
## Multiple-choice questions
An exception to the above format are the multiple-choice questions. These questions are represented in the dataset as `"questionLabel option"` column per option that may be selected. The user answer is then represented as 1 for chosen option, 0 for not chosen option. If the user has not answered the given question at all, the fields are empty (null).
@@ -36,13 +39,14 @@ For submissions being collected across different _language versions_ it is advic
In order to parse the collected submissions you need to download the files from the main course management page on courses.mooc.fi. The links to download the files are shown at the bottom of the picture
-
+
The csv file for course instances is not used in the process and may be skipped. The needed files are:
- submissions
- user details
- exercise-tasks
+- research consent form answers
To download the data-parser go to github release page https://github.com/rage/factor-analysis-exercise-service/releases/tag/release and choose the execution file for your operative system.