R/pk-parameter-info.R

In Open-Systems-Pharmacology/OSPSuite.ReportingEngine: R package to create reports for the Open Systems Pharmacology models

#' @title PkParameterInfo
#' @description R6 class representing workflow selected PK parameter.
#' @field pkParameter PK Parameter name for the simulation (e.g. `AUC_inf`)
#' @field displayName display name for `pkParameter`
#' @field displayUnit display unit for `pkParameter`
#' @field group Grouping identifier
#' @export
#' @import ospsuite
#' @import ospsuite.utils
PkParameterInfo <- R6::R6Class(
  "PkParameterInfo",
  cloneable = FALSE,
  public = list(
    pkParameter = NULL,
    displayName = NULL,
    displayUnit = NULL,
    group = NULL,

    #' @description
    #' Create a new `PkParameterInfo` object.
    #' @param pkParameter PK Parameter name for the simulation (e.g. `AUC_inf`)
    #' Tips: use ospsuite::allPKParameterNames() to get a list of available PK parameters
    #' @param displayName display name for `pkParameter`
    #' @param displayUnit display unit for `pkParameter`
    #' @param group Grouping identifier. Default group associate `pkParameter`.
    #' @return A new `PkParameterInfo` object
    initialize = function(pkParameter,
                          displayName = NULL,
                          displayUnit = NULL,
                          group = NULL) {
      validateIsString(pkParameter)
      validateIsOfLength(pkParameter, 1)
      validateIsString(c(displayName, displayUnit), nullAllowed = TRUE)
      validateIsIncluded(pkParameter, ospsuite::allPKParameterNames())
      ifNotNull(displayName, validateIsOfLength(displayName, 1))
      ifNotNull(displayUnit, validateIsOfLength(displayUnit, 1))

      defaultPKParameterProperties <- ospsuite::pkParameterByName(name = pkParameter)
      validateIsUnitFromDimension(
        displayUnit,
        defaultPKParameterProperties$dimension,
        nullAllowed = TRUE
      )

      self$group <- group %||% pkParameter
      self$pkParameter <- pkParameter
      self$displayName <- displayName %||% defaultPKParameterProperties$displayName
      self$displayUnit <- displayUnit %||% defaultPKParameterProperties$displayUnit
    }
  )
)