MUKMplot {signatureSurvival}

Function multiple univariate Kaplan-Meier survival curve plots

Description

MUKMplot plots the outcomes of univariate survival analyses of patients in a cohort using all selected genes.

Usage

MUKMplot(svdata, stn, gn,HR="hazard risk",time = "month", status = "status", 
         sml="hv",quant=c("No",-0.2,0.2),plotmethod="plot",adjx, outdir = 
         "NULL", file)

Arguments

svdata

survival data including clinical data such as status, month, and expressions of genes or proteins. Status such as death, recurrence or relapse must be 1 for event (such as death) or 0 for no event (such as alive). Genes or signatures are numeric continuous variables. They are listed in columns and patients or observations are listed in rows.

stn

character value specifying gene symbol or gene id existed in sdata or int value specifying column number for the first gene in survival data.

gn

character value specifying gene symbol or gene id existed in sdata or int value specifying column number for the first gene in survival data.

HR

a string for specifying hazard risk or hazard rate. If HR="Hazard risk" or "Hazard_risk", then plot would show coefficient, which has negative, zero, or positive value. The domain is (-\infty,\infty). The Negative value indicates reduction of hazard risk while the positive value suggests increment of risk. Zero suggests no change of hazard risk. If HR = "hazard rate" or "hazard_rate", then plot would show exp(coefficient), which the value is from 0 to \infty and HR < 1 indicates that hazard risk is reduced and HR > 1 means that hazard risk is increased. The default is "hazard risk".

time

string for survival time and may be one of c("day", "month", "year"), depending on the clinical data. The default value is "month".

status

string for a specifying status name. For example, status may be death, relapse or recurrence. User can set status="death", "relapse" or "recurrence" or "status", depending on the data.

sml

surv.median.line: character vector for drawing a horizontal/vertical line at median survival. Allowed values include one of c("none", "hv", "h", "v"). v: vertical, h:horizontal.The value of sml is used in only ggsurvplot. The default is "hv".

quant

vector for quantile, low and high values. the low and high values are used to define or classify low and high expression groups. If quantile is "yes" or "YES", then the low and high are non-negative precent values, for example, quant=c("yes",0.25,0.75). If quantile is "no", then the low and high values are z-scores, the low value may be negative. For example, quant=c("no",-0.2, 0.2). The quantile = "yes" or = "No" may produce different results of survival analysis. User should carefully choose quantile or no quantile according to the data. The default values are c("no",-0.2,0.2).

plotmethod

string value: choose a method to plot Kaplan-Meier survival curves. In current version, we have two methods for choice: "plot" and "ggsurvplot". The defauld is plot method. In plot method, we show p-value for result of Ward-test but in ggsurvplot, we show p-value for the result of log-rank test.

adjx

numeric value used to adjust x-axis position of p-value and HR in only plot.

outdir

string for a folder path to save the image file. If user uses setwd to set a path to save the image file, then outdir is not necessary to be given. The default outdir is "NULL".

file

string for a file name or path and file name. If user sets a path with setwd or set path to outdir, then file just contain file name. The file is pdf file containing all plot pages.

Value

output multiple pdf pages for multiple survival curve plots and saved in a outputting pdf file. If file ="NULL", MUKMplot would output the last survival plot page.

Note

User can use MKMplot to plot all signatures and gives a plot file name to save all signature suvival curve plots.

All inputting parameters are not sensitive to upper or lower. That is, user can input upper or lower string or letter. For example, both time ="MONTH" or time = "month" work.

Author(s)

Yuan-De Tan
[e-mail]
[e-mail]
Yuguang Ban
[e-mail]

See Also

UKMplot,MMKMplot,MKMplot

Examples

data(TCGA_survivalData)
MUKMplot(svdata =TCGA_survivalData,stn=157,gn=160,time ="month", status="status",
plotmethod="plot",adjx = 170,file="NULL")