create_ge_plot_report: Create Report With Plots From Two GE Periods

In fbzwsqualitasag/qgert: Qualitas Genetic Evaluation Routine Tools

Create Report With Plots From Two GE Periods

Description

Based on a Rmarkdown Template (ps_templ) document all plots in given GE directory (ps_gedir) are taken. For a given plot in directory ps_gedir, a corresponding plot with the same filename is searched in an archive directory (ps_archdir). If such a plot is found, the two corresponding plots are shown side-by-side in the generated Rmarkdown report.

Usage

create_ge_plot_report(
  ps_gedir,
  ps_archdir,
  ps_trgdir,
  ps_templ,
  ps_report_text,
  ps_rmd_report = "ge_plot_report.Rmd",
  pb_keep_src = FALSE,
  pb_session_info = TRUE,
  pb_debug = FALSE,
  plogger = NULL
)

Arguments

ps_gedir	directory with plots of current GE round
ps_archdir	archive directory with plots from previous GE
ps_trgdir	target directory where plot files from archive are extracted, relative to ps_gedir
ps_templ	path to Rmarkdown template file
ps_report_text	text that is included in the report before plotting
ps_rmd_report	name of report source file
pb_keep_src	should Rmd source be kept
pb_session_info	should session_info be included
pb_debug	flag indicating whether debug info is printed
plogger	log4r logger object

Examples

## Not run: 
create_ge_plot_report(ps_gedir     = "{path to comparison dir}",
                    ps_archdir     = "{path to archive dir}",
                    ps_trgdir      = "1904/compareBull",
                    ps_templ       = "inst/templates/compare_plots.Rmd.template",
                    ps_report_text = "## Comparison Of Plots\nPlots compare estimates ...",
                    ps_rmd_report  = 'ge_plot_report.Rmd',
                    pb_debug       = TRUE)


## End(Not run)

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