report-qualification-dab2.R

#' @title report-qualification-dab2
#' @description
#' Qualification Report for `Open-Systems-Pharmacology/dAb2-Model` repository

# Clean environment and (re-)load the ospsuite.reportingengine package
rm(list = ls())
library(ospsuite.reportingengine)

# Define input parameters for the workflow
qualificationProject <- "dAb2-Model"
snapshotFile <- "dAb2.json"
workingDirectory <- normalizePath(qualificationProject, mustWork = FALSE, winslash = "/")
qualificationRunnerFolder <- "QualificationRunner/QualificationRunner"
pkSimPortableFolder <- "PK-Sim/PK-Sim"
versionInfo <- QualificationVersionInfo$new("1.0", "11.0", "3.0")

# Load repository content and clean up downloads
download.file("https://github.com/Open-Systems-Pharmacology/dAb2-Model/archive/refs/heads/master.zip", destfile = "archive.zip")
unzip("archive.zip", exdir = "archive")
unlink("archive.zip")
dir.create(workingDirectory)
file.copy("archive/dAb2-Model-master/Evaluation/Input", workingDirectory, recursive = TRUE)
# In this repo, the snapshot is outside the evaluation folder and its path needs to be updated
file.copy(file.path("archive/dAb2-Model-master/", snapshotFile), workingDirectory, recursive = TRUE)
unlink("archive", recursive = TRUE)

#' @description Code hereafter is adapted from `createQualificationReport()` template
qualificationPlanName <- "evaluation_plan.json"
qualificationPlanFile <- file.path(workingDirectory, "input", qualificationPlanName)
jsonContent <- readLines(qualificationPlanFile)
jsonContent <- gsub(pattern = paste0('../', snapshotFile), replacement = snapshotFile, x = jsonContent)
writeLines(jsonContent, qualificationPlanFile)

#' The default outputs of qualification runner should be generated under `<workingDirectory>/re_input`
reInputFolder <- file.path(workingDirectory, "re_input")
#' The default outputs or RE should be generated under `<workingDirectory>/re_output`
reOutputFolder <- file.path(workingDirectory, "re_output")

#' Configuration Plan created from the Qualification Plan by the Qualification Runner
configurationPlanName <- "report-configuration-plan"
configurationPlanFile <- file.path(reInputFolder, paste0(configurationPlanName, ".json"))

#' Set watermark that will appear in all generated plots
#' Default is no watermark. `Label` objects from `tlf` package can be used to specify watermark font.
watermark <- "draft"

#' If not set, report created will be named `report.md` and located in the workflow folder namely `reOutputFolder`
#' Here, the report will be copied in the test reports at the end of the workflow
reportFolder <- file.path("tests/Reports", qualificationProject)
reportPath <- file.path(reportFolder, "Report.md")

#' @description Start **Qualification Runner** to generate inputs for the reporting engine
#' @param logFile If not `null` is passed internally via the `-l` option
logFile <- NULL
#' @param logLevel If not `null` is passed internally via the `--logLevel` option
logLevel <- NULL
#' @param overwrite If `true`, eventual results from the previous run of the QualiRunner/RE will be removed first
overwrite <- TRUE

startQualificationRunner(
  qualificationRunnerFolder = qualificationRunnerFolder,
  qualificationPlanFile = qualificationPlanFile,
  outputFolder = reInputFolder,
  pkSimPortableFolder = pkSimPortableFolder,
  configurationPlanName = configurationPlanName,
  overwrite = overwrite,
  logFile = logFile,
  logLevel = logLevel
)

#' @description Run Qualification Workflow to generate inputs for the reporting engine
titlePageFile <- file.path(reInputFolder, "Intro/titlepage.md")
addTitlePage <- all(
  !is.null(versionInfo),
  file.exists(titlePageFile)
)
if (addTitlePage) {
  adjustTitlePage(titlePageFile, qualificationVersionInfo = versionInfo)
}

#' Load `QualificationWorkflow` object from configuration plan
workflow <- loadQualificationWorkflow(
  workflowFolder = reOutputFolder,
  configurationPlanFile = configurationPlanFile
)

#' Set the name of the final report
workflow$reportFilePath <- reportPath
#' Do not export word report
workflow$createWordReport <- FALSE

#' Set watermark. If set, it will appear in all generated plots
workflow$setWatermark(watermark)

#' Run the `QualificationWorklfow`
workflow$runWorkflow()

# Copy logs to get final run time on reports
file.copy(
  from = file.path(reOutputFolder, "log-info.txt"),
  to = reportFolder,
  overwrite = TRUE
)