From a6b52928908ff1b2958b90e0136ed6c83008c590 Mon Sep 17 00:00:00 2001 From: Jens Sauer Date: Tue, 17 Nov 2020 18:16:57 +0100 Subject: [PATCH] Update README.md Add a much more precise description how this repo can be used. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index ceeb332..399de6b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ secMalASCT statistical analysis =============================== +How to run +---------- +1. Clone the repository +2. Open R and source one of the R files + +survival.R +---------- +Source this file and call one of the plot functions to show plot in R. +`sma_plot_file_surv()` will save all plots to files. + +plot_survival.R +--------------- +Special script to generate all plots and save them in files. +Run with `Rscript plot_survival.R` + +Dependencies +------------ +* git +* R R packages used --------------- * tidyverse +* survival * survminer