Expected behviour from plotHistogram for different pairs of options

[pchelle]

Can you let me know if the expected behaviour of option frequency seems correct.

• frequency = FALSE & stack = FALSE
• frequency = FALSE & stack = TRUE
• frequency = TRUE & stack = FALSE
• frequency = TRUE & stack = TRUE

Code Example

library(tlf)
library(patchwork)

data <- data.frame(
Age = rlnorm(100), 
Gender = c(rep("Female", 60), rep("Male", 40))
)
dataMappingNoGroup <- HistogramDataMapping$new(x = "Age")
dataMappingGroup <- HistogramDataMapping$new(
x = "Age", 
fill = "Gender"
)

frequency = FALSE

stack = FALSE

The count of the total is higher than the count in each group

Code

wrap_plots(
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingNoGroup, stack = FALSE, frequency = FALSE), 
limits = c(0, 50)), 
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingGroup, stack = FALSE, frequency = FALSE), 
limits = c(0, 50)), 
ncol = 2
)

stack = TRUE

The count of the total is the same as the addition (stacking) of count in each group

Code

wrap_plots(
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingNoGroup, stack = TRUE, frequency = FALSE), 
limits = c(0, 50)), 
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingGroup, stack = TRUE, frequency = FALSE), 
limits = c(0, 50)), 
ncol = 2
)

frequency = TRUE

stack = FALSE

The relative frequency is calculated within each group aiming at having comparable distributions between groups.

In this example,

• Total count is divided by 100
• Male gender is divided by 40
• Female gender is divided by 60

Code

wrap_plots(
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingNoGroup, stack = FALSE, frequency = TRUE), 
limits = c(0, 0.5)), 
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingGroup, stack = FALSE, frequency = TRUE), 
limits = c(0, 0.5)), 
ncol = 2
)

stack = TRUE

The relative frequency is calculated from the total count
So that the frequency of the total is the same as the addition (stacking) of frequencies of each group

Code

wrap_plots(
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingNoGroup, stack = TRUE, frequency = TRUE), 
limits = c(0, 0.5)), 
setYAxis(
plotHistogram(data = data, dataMapping = dataMappingGroup, stack = TRUE, frequency = TRUE), 
limits = c(0, 0.5)), 
ncol = 2
)

[Felixmil]

I think this is good. However, I would increase the alpha level for stack=FALSE plots to improve readability.