SurvFlow: Survflow

View source: R/SurvFlow.R

SurvFlowR Documentation

Survflow

Description

Survflow

Usage

SurvFlow(
  Data,
  Variables,
  LegendLabels = NULL,
  Identifier,
  PlotTitles = NULL,
  SurvivalStatus,
  SurvivalTime,
  SurvivalTimeUnit,
  xYearSurvivalVar = 5,
  SurvBase = FALSE
)

Arguments

Data

A Coded dataset

Variables

A list of variables (coded as 0 and 1) for analysis

LegendLabels

Optional labels for legend

Identifier

Identifier variable for cases

PlotTitles

Optional plot titles

SurvivalStatus

A status variable (coded as 0 and 1) for survival analysis

SurvivalTime

A survival time variable - continuous

SurvivalTimeUnit

The unit of time for survival time. Months etc

xYearSurvivalVar

The number of years to be used to calculate 'X' years survival. Default = 5

SurvBase

Takes TRUE or FALSE. Toggle to activate base survival analysis.

Value

Takes a coded dataset (use CutFlow) and runs survival analysis for each variable, by each survival outcome, and returns output.

Author(s)

Hayman, l.hayman.1@research.gla.ac.uk This function takes in a dataset(s), produces cut points, recodes your datasets and runs appropriate survival analysis.

Examples

SurvFlow(Glasgow,  Variables = c("GD_PercPositiveCellsinHealthyTissue_Coded", "GD_PercPositiveCellsinTumourTissue_Coded", "CD8_PercPositiveCellsinHealthyTissue_Coded", "CD8_PercPositiveCellsinTumourTissue_Coded"), LegendLabels = c("Low", "High"), Identifier = "TMA_ID", PlotTitles = c("GD Healthy Stroma", "GD Healthy Epithelium", "GD Healthy Tissue", "GD Tumour Stroma", "GD Tumour Epithelium", "GD Tumour Tissue", "CD8 Healthy Stroma", "CD8 Healthy Epithelium", "CD8 Healthy Tissue", "CD8 Tumour Stroma", "CD8 Tumour Epithelium", "CD8 Tumour Tissue"), SurvivalStatus = c("CSS", "OS", "DFS", "RFS"), SurvivalTime = c("CSS_2017", "CSS_2017", "DFSmonths", "DFSmonths"), xYearSurvivalVar = 5, SurvivalTimeUnit = "Months", SurvBase = TRUE)

HHayman/FlowR documentation built on April 13, 2022, 11:31 p.m.