You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. For better clarity, a checkbox has been added that allows users to control the display of the text field for custom strings that the tool searches for (introduced in v0.2).
14
+
1. Added sample CSV files (English and German) with which the "Resonse File Processor" can be tested.
15
+
1. Updated the docs.
16
+
17
+
## Version 0.2
18
+
19
+
Released 12th April 2024
20
+
21
+
1. Option to create a column with the random seed used in each attempt.
22
+
1. Option to specify a list of strings that the tool searches for in each row of the quiz data. The column will be filled with boolean values (True or False), depending on whether each strings are present in the individual rows. For example, the list of strings may include answer notes (e.g. `prt1-1-F`) or answer test results (e.g. `ATList_wrongentries`).
A Python tool to extract information from Moodle response files.
9
9
10
-
## Version v0.2
10
+
## Version v0.3
11
11
12
-
On 12th April 2024, version v0.2 of the Response File Processor has been released. The following features have been added:
12
+
On 24th October 2024, version v0.3 of the *STACK Response File Processor* has been
13
+
released. The following changes have been made:
13
14
14
-
- Option to create a column with the random seed used in each attempt.
15
-
- Option to specify a list of strings that the tool searches for in each row of the quiz data. The column will be filled with boolean values (True or False), depending on whether each strings are present in the individual rows. For example, the list of strings may include answer notes (e.g. `prt1-1-F`) or answer test results (e.g. `ATList_wrongentries`).
1. For better clarity, a checkbox has been added that allows users to control the display of the text field for custom strings that the tool searches for (introduced in v0.2).
17
+
1. Added sample CSV files (English and German) with which the "Response File Processor" can be tested.
18
+
2. Updated the docs.
19
+
20
+
For changes in older versions, please see the [development history](Development_history.md).
16
21
17
22
## About
18
23
@@ -32,38 +37,70 @@ available in the response file. Another convenient feature is the conversion of
32
37
the strings in the "Time spent" column (e.g. 14 mins 7 secs) to seconds
33
38
(e.g. 847) for better processing.
34
39
35
-
36
40
## Prerequisites
37
41
38
42
Before using the tool, ensure you have the following prerequisites:
39
43
40
44
1. Python installed on your system (version 3.6 or higher).
41
-
1. Required Python libraries: `tkinter`, `pandas`, `re` and `json`
45
+
1. Required Python libraries: `tkinter`, `pandas`, `re` and `json`:
46
+
- Instructions on how to install `tkinter` can be found [here](https://www.pythonguis.com/installation/install-tkinter-windows/) (Windows) and [here](https://www.pythonguis.com/installation/install-tkinter-mac/) (macOS).
47
+
- Instructions on how to install `pandas` can be found [here](https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#installing-from-pypi).
48
+
-`re` and `json` are likely to be pre-installed.
42
49
43
50
## Usage
44
51
52
+
For users who prefer standalone solutions, experimental standalone files for
53
+
macOS (app) and Windows (exe) are available (see [here](releases)), but it is
54
+
recommended to use the tool via the command line as described below.
55
+
45
56
To use the Python tool, follow these steps:
46
57
47
58
1. Download the file `response-file-processor.py` from this repository.
48
59
49
-
1. Get your data: Export a "Responses" quiz report from Moodle as a CSV file:
60
+
2. Get your data: To get started, you can use a [sample file](sample_data) from
61
+
this repository. To use your own data, export a "Responses" quiz report from
62
+
Moodle as a CSV file:
50
63
1. Log in to Moodle and click on the quiz you want to access the report for.
51
-
Make sure you have the rights to access the student's responses!
52
-
1. Click on "Results" and select "Responses".
53
-
1. Choose the attempts that you want to export and choose the output format
64
+
Make sure you have the rights to access the students' responses!
65
+
2. Click on "Results" and select "Responses".
66
+
3. Choose the attempts that you want to export and choose the output format
54
67
`.csv`.
55
-
1. Click on the "Download" button.
68
+
4. Click on the "Download" button.
69
+
70
+
3. Run the tool: Open the command line or terminal, navigate to the directory
71
+
where the file `response-file-processor.py` is located. When you saved the
72
+
file in your Downloads folder, the command is likely to be
56
73
57
-
1. Run the Tool: Open the command line or terminal, navigate to the directory
58
-
where the file `response-file-processor.py` is located, and run the tool
59
-
with the following command:
74
+
```
75
+
cd Downloads
76
+
```
77
+
78
+
4. Run the tool with the following command:
60
79
61
80
```
62
81
python3 response-file-processor.py
63
82
```
64
83
65
84
When the GUI appears, follow the instructions.
66
85
86
+
## Citing
87
+
88
+
If you use the *STACK Response File Processor* for a scientific publication, I would be grateful if you would cite the following [paper](https://zenodo.org/records/12795092):
89
+
90
+
```bibtex
91
+
@InProceedinbgs{lacheDataProcessionMade2024,
92
+
title = {Data {{Procession Made Easy}}: {{A Python Tool}} for {{Extracting Information}} from {{Student Responses}} to {{STACK Questions}}},
93
+
booktitle = {Proceedings of the {{International Meeting}} of the {{STACK Community}} 2024},
94
+
author = {Lache, Jonas},
95
+
editor = {Weinmann, Michael},
96
+
year = {2024},
97
+
pages = {26--32},
98
+
publisher = {International Meeting of the STACK Community 2024 (STACK Conference 2024)},
99
+
address = {Amberg},
100
+
doi = {10.5281/zenodo.12755221}
101
+
}
102
+
```
103
+
67
104
## License
68
105
69
106
The *STACK Response File Processor* is released under the GPL-3.0-or-later
0 commit comments