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 %>% getIOVs() %>% getNames()
  
  arm <- dataset@arms %>% default()
  bootstrap <- arm@bootstrap
  
  summary@covariate_names <- c(dataset %>% getCovariates() %>% getNames(), bootstrap %>% getNames())
  summary@event_covariate_names <- dataset %>% getEventCovariates() %>% getNames()
  summary@occ_names <- dataset %>% getOccasions() %>% getNames()
  
  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)
}
Calvagone/campsis documentation built on April 17, 2024, 5:33 a.m.