Improvements to the PlotGridConfiguration class

[IndrajeetPatil]

• Closes Implement print for PlotGridConfiguration #274
• Closes Add fields to PlotGridConfiguration class to control tag aesthetics #294

[IndrajeetPatil]

Print output:

library(tlf)

set.seed(123)
ls_plots <- list(
  # first plot
  plotBoxWhisker(mtcars,
    dataMapping = BoxWhiskerDataMapping$new(x = "am", y = "wt"), outliers = FALSE
  ),
  # second plot
  plotBoxWhisker(ToothGrowth,
    dataMapping = BoxWhiskerDataMapping$new(x = "supp", y = "len")
  )
)

plotGridObj <- PlotGridConfiguration$new(ls_plots)

plotGridObj$title <- "my combined plot"
plotGridObj$subtitle <- "something clever"
plotGridObj$caption <- "something dumb"
plotGridObj$nColumns <- 2L
plotGridObj$nRows <- 1L
plotGridObj$byRow <- TRUE
plotGridObj$tagLevels <- "A"
plotGridObj$tagPrefix <- "Plot ("
plotGridObj$tagSuffix <- ")"

plotGridObj
#> PlotGridConfiguration: 
#>    Plot grid annotations: 
#>      Title: my combined plot 
#>      Subtitle: something clever 
#>      Caption: something dumb 
#>    Plot grid arrangement: 
#>      Number of plots included: 2 
#>      Number of columns in the grid: 2 
#>      Number of rows in the grid: 1 
#>      Arranged in row-major order: TRUE 
#>    Individual plot tags: 
#>      Tag level format: A 
#>      Tag level prefix: Plot ( 
#>      Tag level suffix: ) 
#>      Tag level separator:

^{Created on 2022-05-24 by the reprex package (v2.0.1.9000)}

[IndrajeetPatil]

library(ggplot2)
library(tlf)

# plots to be arranged in a grid
set.seed(123)
ls_plots <- list(
  plotHistogram(x = rnorm(100)),
  plotHistogram(x = rnorm(100, mean = 3)),
  plotHistogram(x = rnorm(100, mean = 10))
)

# create an instance of plot configuration class
plotGridObj <- PlotGridConfiguration$new(plotList = ls_plots)

# specify further customizations for the plot grid
plotGridObj$title <- "my combined plot"
plotGridObj$subtitle <- "something clever"
plotGridObj$caption <- "my sources"
plotGridObj$nColumns <- 2L
plotGridObj$tagLevels <- "A"
plotGridObj$tagPrefix <- "Plot ("
plotGridObj$tagSuffix <- ")"
plotGridObj$tagColor <- "orange"
plotGridObj$tagSize <- 15
plotGridObj$tagAngle <- 45
plotGridObj$tagPosition <- TagPositions$top
plotGridObj$titleColor <- "darkgreen"
plotGridObj$subtitleColor <- "darkred"
plotGridObj$captionColor <- "blue"
plotGridObj$captionSize <- 12
plotGridObj$titleHorizontalJustification <- HorizontalJustification$middle
plotGridObj$subtitleHorizontalJustification <- HorizontalJustification$middle
plotGridObj$captionHorizontalJustification <- HorizontalJustification$middle

# plot the grid
plotGrid(plotGridObj)

^{Created on 2022-05-24 by the reprex package (v2.0.1.9000)}

[codecov-commenter]

Codecov Report

Merging #293 (783baba) into develop (fe1fb85) will increase coverage by 6.48%.
The diff coverage is 74.74%.

@@             Coverage Diff             @@
##           develop     #293      +/-   ##
===========================================
+ Coverage    57.79%   64.28%   +6.48%     
===========================================
  Files           51       51              
  Lines         2827     2878      +51     
===========================================
+ Hits          1634     1850     +216     
+ Misses        1193     1028     -165     

Impacted Files	Coverage Δ
R/tlf-env.R	0.00% <0.00%> (ø)
R/utilities-axis.R	64.70% <64.70%> (ø)
R/plot-grid.R	80.51% <71.15%> (+49.75%)	⬆️
R/utilities-export.R	81.04% <81.04%> (ø)
R/font.R	86.95% <86.95%> (ø)
R/aggregation-input.R	90.69% <90.69%> (ø)
R/utilities-aesthetics.R	94.73% <94.73%> (ø)
R/plotconfiguration-background.R	87.14% <100.00%> (ø)
R/plotconfiguration-axis.R	88.57% <0.00%> (+5.00%)	⬆️
R/boxwhisker-plotconfiguration.R	100.00% <0.00%> (+62.50%)	⬆️
... and 4 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe1fb85...783baba. Read the comment docs.

[IndrajeetPatil]

@Yuri05 Bumping the version. Is that okay?

[Yuri05]

Yes :)

[IndrajeetPatil]

@Yuri05 Same as DESCRIPTION

[IndrajeetPatil]

So that visual regression tests can run on AppVeyor

[Yuri05]

don't we have this (and other sizes below) as a constant somewhere in the tlf?

[IndrajeetPatil]

No, but I have created an enum for it now.

[IndrajeetPatil]

@pchelle Please make note of this. I have moved all enums to a single file now.

I need to some more research into this, but keeping them in a single file is a good solution at the moment.

[IndrajeetPatil]

@Yuri05 I have made the changes you had asked. Let me know if you want me to change anything else.

[Yuri05]

Let me know if you want me to change anything else.

Change the world :)
PR looks good, merging