create_comparison_plot_report: Create Generic Form of Comparison Plot Report

In fbzwsqualitasag/qgert: Qualitas Genetic Evaluation Routine Tools

Create Generic Form of Comparison Plot Report

Description

Given two directories with analogous plots, a comparison plot report is created. The comparison plot report shows pairs of analogous plots side-by-side in the report. Analogous plots can be plots of the same quantities at different time points. Analogous plots are identified by the same name of the plot file. Plots in the directory ps_current_dir are shown on the right-hand side and plots from the directory ps_previous_dir are shown on the left-hand side.

Usage

create_comparison_plot_report(
  ps_right_dir,
  ps_left_dir,
  ps_tmpl_path = system.file("templates",
    "generic_comparison_plot_report.Rmd.template", package = "qgert"),
  ps_diagram_na_path = system.file("templates", "Diagram_NA.pdf", package = "qgert"),
  ps_report_text = NULL,
  pl_repl_value = NULL,
  ps_out_path = "generic_comparison_plot_report.Rmd",
  pb_keep_src = FALSE,
  pb_session_info = FALSE,
  pb_force = FALSE,
  pb_debug = FALSE,
  plogger = NULL
)

Arguments

ps_right_dir	directory of plots shown on the right-hand-side in the report
ps_left_dir	directory of plots shown on the left-hand-side in the report
ps_tmpl_path	path to Rmd template file
ps_diagram_na_path	path to diagram to be included to stand for missing diagram
ps_report_text	Report text
pl_repl_value	list of replacement values for placeholders
ps_out_path	Path to report putput file
pb_keep_src	flag to keep source files
pb_session_info	add session info to report
pb_force	overwrite existing report, if it exists
pb_debug	flag to add debugging info
plogger	log4r logger object

Details

The report generator starts by retrieving all plot files from ps_current_dir and from ps_previous_dir. Then it determines the intersection between the file-names and the two difference sets. In loops over all the sets, the plots are integrated into the report.

Examples

## Not run: 
dir1 <- system.file("extdata", "curgel", package = "qgert")
dir2 <- system.file("extdata", "prevpath", package = "qgert")
create_comparison_plot_report(ps_right_dir = dir1, ps_left_dir = dir2)

## End(Not run)

fbzwsqualitasag/qgert documentation built on July 1, 2022, 9:41 a.m.