get_plot_info: Get Plotting Information

Description Usage Arguments Value

View source: R/comparisons.R

Description

This internal function obtains the data tables necessary for plotting. For continuous and binary covariates, the mean observed and simulated values are obtained for each time point. For categorical covariates, the observed and simulated counts of the levels of the factors are obtained for each time point. When the outcome is of type "survival", the observed and simulated risk and survival are obtained for each time point.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
get_plot_info(
  outcome_name,
  compevent_name,
  time_name,
  time_points,
  covnames,
  covtypes,
  nat_pool,
  nat_result,
  comprisk,
  outcome_type,
  obs_data
)

Arguments

outcome_name

Character string specifying the name of the outcome variable in obs_data.

compevent_name

Character string specifying the name of the competing event variable in obs_data.

time_name

Character string specifying the name of the time variable in obs_data.

time_points

Number of time points to simulate.

covnames

Vector of character strings specifying the names of the time-varying covariates in obs_data.

covtypes

Vector of character strings specifying the "type" of each time-varying covariate included in covnames. The possible "types" are: "binary", "normal", "categorical", "bounded normal", "zero-inflated normal", "truncated normal", "absorbing", "categorical time", and "custom".

nat_pool

Pooled-over-time data table containing simulated data under the natural course.

nat_result

Vector containing the mean outcome over all subjects at each time for natural course.

comprisk

Logical scalar indicating the presence of a competing event.

outcome_type

Character string specifying the "type" of the outcome. The possible "types" are: "survival", "continuous_eof", and "binary_eof".

obs_data

Data table containing observed data.

Value

A list with the following components:

obs_results

A list of the mean observed values at each time point for covariates and - if the outcome is of type "survival" - the risk and survival.

dt_cov_plot

A list of data tables The data tables contain the observed and simulated mean values of the covariates under each time point.

dt_obs_plot

For outcomes of type "survival", a list of data tables. The data tables contain the observed and simulated risks and survival under each time point. For other outcomes, a value of NA is given.


gfoRmula documentation built on July 13, 2021, 9:07 a.m.