R/dexr_hl_reports.R

Defines functions hl_reports_comp

Documented in hl_reports_comp

#' Create a report for the given <code>ids</code> based on the given <code>dexpa</code> (e.g. dumpdir).
#' 
#' Loads data from dumpfiles into database and drops these afterwards.
#' 
#' @param dexpa parameter object required for e.g. dump dir configuration 
#' @param ids IDs of runs to compare
#' @param reporttmpl template for report
#' @param outfileprefix prefix for output filename
#' @return comparison report
#' 
#' @author Sascha Holzhauer
#' @export
hl_reports_comp <- function(dexpa, ids, reporttmpl="DEX_report_compare_slides.Rmd",
		outfileprefix = paste(dexpa$sim$project, "_ComparisonReport", sep="_"), clean=T, dropdb = T) {
	dexpas <- dexR::create_dexpas(ids, dexpa=dexpa)

	dexR::input_db_dumps2db(dexpas)

	dexR::createCompareReport(dexpas, 
		rmdfile = reporttmpl, 
		outputfile = paste(outfileprefix, "__", paste(lapply(dexpas, function(x) x$sim$id), collapse="__"), ".pdf", sep=""),
		clean = clean)

	## drop DBs:
	if (dropdb) {
		dexR::input_db_dropdbs(dexpas)
	}
}
UniK-INES/dexR documentation built on June 30, 2021, 11:05 p.m.