R/dataset_summary.R

Defines functions toDatasetSummary DatasetSummary

Documented in DatasetSummary toDatasetSummary

#_______________________________________________________________________________
#----                       dataset_summary class                           ----
#_______________________________________________________________________________

setClass(
  "dataset_summary",
  representation(
    covariate_names = "character",
    iov_names = "character",
    event_covariate_names = "character",
    occ_names = "character",
    tsld_tdos_names = "character"
  )
)

#'
#' Create a dataset summary (internal method).
#'
#' @return a dataset summary
#' @keywords internal
DatasetSummary <- function() {
  return(new("dataset_summary"))
}

#'
#' Convert dataset to dataset summary (internal method).
#'
#' @return a dataset summary
#' @keywords internal
toDatasetSummary <- function(dataset) {
  summary <- DatasetSummary()
  summary@iov_names <- dataset %>% get_iovs() %>% get_names()

  arm <- dataset@arms %>% default()
  bootstrap <- arm@bootstrap

  summary@covariate_names <- c(dataset %>% get_covariates() %>% get_names(), bootstrap %>% get_names())
  summary@event_covariate_names <- dataset %>% get_event_covariates() %>% get_names()
  summary@occ_names <- dataset %>% get_occasions() %>% get_names()

  config <- dataset@config
  if (config@export_tsld) {
    summary@tsld_tdos_names <- c(summary@tsld_tdos_names, "TSLD")
  }
  if (config@export_tdos) {
    summary@tsld_tdos_names <- c(summary@tsld_tdos_names, "TDOS")
  }
  return(summary)
}

Try the campsis package in your browser

Any scripts or data that you put into this service are public.

campsis documentation built on Aug. 5, 2026, 9:07 a.m.