surv_designation: Create a "surv_DF" attribute so that survival analysis can be...

View source: R/surv_designation.R

surv_designationR Documentation

Create a "surv_DF" attribute so that survival analysis can be implemented.

Description

This function will add the necessary information to omicsData such that survival analysis can be applied to it.

Usage

surv_designation(
  omicsData,
  t_death,
  t_progress = NULL,
  ind_death,
  ind_progress = NULL,
  covariates = NULL
)

Arguments

omicsData

an object of the class 'lipidData', 'metabData', 'pepData', or 'proData' usually created by as.lipidData, as.metabData, as.pepData, or as.proData, respectively.

t_death

the column in 'f_data' that corresponds to the subjects' time of death

t_progress

the column in 'f_data' that corresponds to the subjects' time of progression

ind_death

the column in 'f_data' that corresponds to the subjects' status, e.g. alive/dead

ind_progress

the column in 'f_data' that corresponds to the subjects' progression status

covariates

the column(s) in 'f_data' that correspond to covariates to be included in the survivial analysis

Value

omicsData is returned with the additional attribute

Author(s)

Bryan Stanfill


pmartR/pmartR documentation built on April 24, 2024, 10:22 p.m.