pmartR (version 2.4.6)

summary_km: Basic survival analysis summary

Description

Implements overall survival analysis or progression-free survival analysis, depending upon the datatypes supplied to surv_designation, and gives a summary of the results.

Usage

summary_km(omicsData, percent = NULL, ...)

Value

if `percent` is provided then the time at which that probability of death is returned; else, the summary of the `survival` object is returned

Arguments

omicsData

A pmartR data object of any class, which has a `group_df` attribute that is usually created by the `group_designation()` function

percent

The percentile

...

extra arguments passed to regexpr if pattern is specified

Examples

if (FALSE) { # requireNamespace("pmartRdata", quietly = TRUE)
if (FALSE) {
library(OvarianPepdataBP)
attr(tcga_ovarian_pepdata_bp, "survDF") <- list(t_death = "survival_time",
                                                ind_death = "vital_status")
# No percent is provided so the entire object is returned
summary_km(tcga_ovarian_pepdata_bp)

# Percent is provided so corresponding time point is returned
summary_km(tcga_ovarian_pepdata_bp, .4)
}
}