Specification for plotBoxAndWhisker()

[IndrajeetPatil]

Related to #674

Signature

The function is called plotBoxAndWhisker(), and not plotBoxWhisker() because the latter already exists in tlf package, and we should avoid any namespace collision.

# x The variable to be plotted against grouping variable.
# `...` will be parameters to control annotations and aesthetics of the plot
plotBoxAndWhisker(dataCombined, x, ...)

Implementation plan

data <- dataCombined$toDataFrame()

tlf::plotBoxWhisker(data, ...) 

Rough expected output:

(The x-axis will be mapped to group variable in the dataframe.)

Decision points:

N.B. The option already rejected by the team is scratched out.

• Should plotBoxAndWhisker() have x argument that allows the users to specify the variable versus should it always be a fixed variable like residuals?
• Should the values be plotted for simulated versus observed data? (e.g., if x = yValues, which yValues does it correspond to?)

Tasks

Each task will get its own PR.

• Implement plotBoxAndWhisker()

[IndrajeetPatil]

@PavelBal Do we actually need to implement this plot? I do not see it mentioned in the original issue. I just assumed that it was needed.

Also, it's such a simple plot that nobody needs to go the trouble of going the route of an R6 object.

We are also not implementing DDI, PK ratio, etc. plots, so it won't be internally inconsistent to not have every plotting functions take in a DataCombined object.

[PavelBal]

@IndrajeetPatil Not now, low prio.