Codebook in Kodierbox an Studio-Codebook anpassen

[schumaki]

Beschreibung

Im Reiter Kodierübersicht der Kodierbox kann ein Codebook ausgegeben werden. Das ist insbesondere dann wichtig, wenn nach einer Schulung die Kodierschemata (in der Kodierbox) überarbeitet wurden, da diese Änderungen im Studio nicht vorgenommen werden.

Aktuell enthält dieses Codebook allerdings nur die Codes 1, 2, 4, ... aber nie Code 0.
Werden die selben Aufgaben im Studio in einem Codebook ausgegeben, ist Code 0 dort enthalten.

Außerdem gibt es weitere Unterschiede, u. a.:

• Item-Variablen-Relation fehlt
• Unit-Überschrift unterscheidet sich
• Layout (Schriftart, usw.) unterscheidet sich

Erwartetes Verhalten

Die Codebooks in Kodierbox und Studio sollten (bis auf inhaltliche Unterschiede in den Kodierschemata) identisch aussehen.

Wenn möglich sollte die Kodierbox hier auf die Implementation aus dem Studio referenzieren und sich automatisch aktualisieren, falls diese geändert wird.

Reproduktionsschritte

s. Beschreibung

Workaround

Man müsste die Aufgaben aus der Kodierbox exportieren, im Studio wieder importieren und dann das Codebook dort ausgeben.
Oder die Änderungen im Studio machen, dann die Aufgaben dort exportieren und in die Kodierbox importieren. Beides würde die Auswertung der Schulung unnötig und nicht unerheblich verlangsamen.

Beispiele

• Kodierbox: V3-Ma_Pilo26: KKS Testbereich
• Studio-Referenz: VERA MaP: 2027 Pilotierung (MS+GM)_ID

---

Versionen

• Verwendete Schemer- und Kodierboxversion:
  • Kodierbox: V 1.16.1
  • Schemer: V 2.7.0
  • Editor: Aspect 2.12.5

Weitere Informationen

Priorisierung:

• Code 0 ist Urgent, weil für die manuelle Kodierung dringend benötigt
• die restlichen Abweichungen sind High, je nach Effort aber ggf. nachrangig

[jurei733]

Zur Einordnung: Die Vereinheitlichung der Codebook-Logik ist bereits im iqb-berlin/coding-components-Repo angelegt.

• Ticket: Gemeinsame Codebook-Logik fuer manuelle Codes bereitstellen coding-components#176
• Laufende Umsetzung: Codebook export secondary entry points coding-components#177

#176 zielt darauf, die Codebook-Logik zentral bereitzustellen, damit Studio und Kodierbox dieselbe Semantik verwenden. #177 enthält bereits die bestehende Bearbeitung am Codebook-Export/Generator und richtet den DOCX-Output weiter am Studio-Verhalten aus.

Für dieses Ticket hier sollten wir deshalb möglichst nicht noch eine separate Kodierbox-Implementierung pflegen, sondern die gemeinsame Logik bzw. den Export aus coding-components übernehmen. Der Punkt „Code 0 fehlt“ sollte dabei explizit gegen den Stand aus #177 geprüft und, falls noch nicht abgedeckt, dort als Akzeptanzkriterium ergänzt werden.

[schumaki]

Verstehe. Das ist natürlich die sauberere (aber anscheinend nicht ganz unaufwändige) Lösung.

Falls der Punkt „Code 0 fehlt“ ohne Aufwand in der bestehenden (bald obsoleten) Kodierbox-Codebook-Logik ergänzt werden kann, wäre es super, das noch in V 1.16.2 als Quickfix aufzunehmen.

[jurei733]

Ja, einverstanden. Ich prüfe den Punkt „Code 0 fehlt“ separat darauf, ob er sich mit überschaubarem Aufwand in der bestehenden Kodierbox-Codebook-Logik ergänzen lässt.

Wenn das ohne größere Eingriffe möglich ist, würde ich das als Quickfix für V 1.16.2 vorziehen. Die weitergehende Angleichung an das Studio-Codebook bleibt dann weiterhin über die gemeinsame coding-components-Logik bzw. iqb-berlin/coding-components#176/#177 adressiert.

[schumaki]

Perfekt, danke.

[jurei733]

Der Quickfix für den Punkt „Code 0 fehlt“ ist mit #786 gemerged.

Kurz zur Änderung:

• Die Codebook-Erzeugung prüft Code-IDs jetzt explizit auf undefined/null, statt 0 durch eine Truthy-Prüfung zu verwerfen.
• Dadurch wird der gültige numerische Code 0 im Codebook-Export wieder mit ausgegeben.
• Ergänzt wurde eine Regressionstest-Abdeckung für die Code-Extraktion und den generierten JSON-Codebook-Output.

Die größere Angleichung des Codebooks an das Studio-Verhalten bleibt davon unabhängig weiterhin der separate Punkt.