Re-do output structure of report()

[beckerbenj]

Currently the output structure of report() is rather messy and difficult to comprehend. See below file for an overview and suggestions for an overhaul.

This should be restructured and properly documented. Also be aware of further processing by eatPlot

[beckerbenj]

Suggestions

• Sig_trend and p_trend should be in the same column (in p_trend)
• Maybe more consistent long format
• In column „comparison“ simply the order of comparisons is listed
• name suggestions: gDiff, trend, cDiff
• Be aware: if trend is the last comparison, this is located in the column of the prior comparison (document explicitly?)
• group column consists of strings which are joined together, from which the user must reconstruct the desired information. The information must be captured in separate unambigious columns

Simple Comparisons gDiff cDiff trend (Spalte)

Double comparison gDiff_cDiff (currently: crossDiff_of_groupDiff) cDiff_gDiff (does currently not exist) gDiff_trend (Trend column in gDiff row) trend_gDiff (currently: trendDiff_group) cDiff_trend (Trend column in cDiff row) trend_cDiff (currently trendDiff_cross)

Triple comparison gDiff_cDiff_trend (Trend column in row crossDiff_of_groupDiff) cDiff_gDiff_trend (does currently not exist) gDiff_trend_cDiff (currently trendDiff_cross) cDiff_trend_gDiff (does currently not exist) trend_cDiff_gDiff (does currently not exist) trend_gDiff_cDiff (does currently not exist)

Challenges

• Trend_cDiff and gDiff_cDiff_trend are currently difficult to distinguish (as both are trendDiff_cross in column comparisons)
• For triple comparisons, consider whether one of the two options could be dropped (maybe gDiff_trend_cDiff?)
• If cross differences with WEC are requested, the modus column in the output is inconsistent (contains "JK2.mean" and "JK2.glm" although the user requested only one type of analysis and expects consistent values). Moreover, the modus column jumbles technical issues (survey, BIFIEsurvey) and content issues (mean, table, glm)

[beckerbenj]

Suggestions @nickhaf:

• up to three comparison columns (no group column)
• no dynamic column names (such as currently for years)

Tidy data principle: each information has a designated cell

[beckerbenj]

Open question: Backwards compatability? report2()? But maintainability? Clean cut?

[beckerbenj]

Meeting with @beckerbenj , @nickhaf, @buchjani

[beckerbenj]

Structure more or less discussed and agreed upon; implementation lead @weirichs

[nickhaf]

@nickhaf: Baut Beispiel aus

[nickhaf]

@nickhaf stellt Termin ein mit SW, JB

[nickhaf]

Termin hat stattgefunden, @weirichs ist an der Umsetzung

[nickhaf]

Beispiel für die neue Struktur: P:\Methoden\02_R_Pakete\eatRep\Outputstruktur

[sachseka]

@weirichs hat Outputstruktr vorgestellt, Austausch dazu im Gange

[nickhaf]

Termin zur Userbefragung wurde angesetzt

[nickhaf]

Termin hat stattgefunden. Es gab keine klare Präferenz. SW setzt probeweise Text und "Formel"-Schreibweise für Labels um.

NH erstellt kurzen Absprache-Termin dazu, um Ergebnisse und nächste Schritte zu sammeln.

[sachseka]

SW hat gemäß Umfrageergebnis was umgesetzt, wir schauen uns das jetzt mal an.

[sachseka]

@nickhaf hat schon drüber geschaut @sachseka schaut noch -- @weirichs übersetzt auf ENG

[nickhaf]

Auch nicht variierende Kodierungsvariable wird in die label-Spalte mit aufgenommen. Labels auch für nicht comparisons.

[nickhaf]

Sebastian ist noch am basteln

[nickhaf]

@weirichs ist noch an der techn. Umsetzung

[nickhaf]

Funktionalität steht, @weirichs räumt Code auf

[nickhaf]

Änderung ist soweit fertig, alte Version soll noch mit Versionsnummer konserviert werden, weil danach ein Breaking change kommt. @buchjani reviewed.

[sachseka]

alte reportingfkt ist jetzt deprecated, geht noch, aber hat nicht mehr denselben Output. @buchjani Review steht noch aus. Kommt das noch? oder soll @weirichs ohne Review pushen? eher nicht. @buchjani machts heute!

[nickhaf]

@buchjani hat gereviewed , @weirichs überarbeitet