summary.IDEMDATA: Summary of IDEMDATA object

View source: R/idem_data.R

summary.IDEMDATAR Documentation

Summary of IDEMDATA object

Description

Summarize the missing data information for class IDEMDATA objects generated by imData.

Usage

## S3 method for class 'IDEMDATA'
summary(object, opt = c("misstable", "missid", "trt"), endponly = FALSE, ...)

Arguments

object

A class IDEMDATA object returned by imData

opt

Types of the summarization

  • misstable: Summarize the frequencies of each missing pattern

  • missid: Summarize the indices of subjects that need imputation, i.e. survivors with functional endpoint missing

  • trt: Treatment arms

endponly

Logical variable that indicates whether clinical outcomes not used in calculating the functional outcome are considered as missing and should be imputed. The default is FALSE, indicating that all missing clinical outcomes will be imputed sequentially

...

Extra arguments

Value

A dataframe with frequencies of each missing pattern when opt is misstable.

A vector of indices of subjects that need imputation when opt is missid.

A vector of treatment arms in the data when opt is trt.

See Also

imData


idem documentation built on Aug. 9, 2023, 5:08 p.m.