diff lifelines_tool/README.md @ 0:dd49a7040643 draft

Initial commit
author fubar
date Wed, 09 Aug 2023 11:12:16 +0000
parents
children 232b874046a7
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lifelines_tool/README.md	Wed Aug 09 11:12:16 2023 +0000
@@ -0,0 +1,35 @@
+# lifelines_tool - lifelines statistical package wrapped as a Galaxy tool.
+
+## Galaxy tool to run failure time models using lifelines
+
+## Install to your Galaxy server from the toolshed - search for lifelines_tool owned by fubar2
+
+### More at https://lazarus.name/demo/
+
+#### Using the Rossi sample input data from lifelines, tool outputs include:
+
+![KM plot sample](lifelines_rossi_km.png)
+and
+![KM plot sample](lifelines_rossi_schoenfeld.png)
+and
+![KM plot sample](lifelines_report.png)
+
+
+Runs Kaplan-Meier and generates a plot. Optional grouping variable.
+If 2 groups, runs a log-rank test for difference.
+Plots show confidence intervals
+
+If a list of covariate column names is provided, these are used in a
+Cox Proportional Hazards model with tests for proportionality.
+
+Should work with any tabular data with the required columns - time and status for observations.
+
+Issues to https://github.com/fubar2/lifelines_tool please.
+Autogenerated so pull requests are possibly meaningless but regeneration of a new version is easy so please tell me what is needed.
+
+## Tool made with the Galaxy ToolFactory: https://github.com/fubar2/galaxy_tf_overlay
+The current release includes this and a generic tabular version, and a java .jar wrapper in a history where the generating
+ToolFactory form can be recreated using the redo button. Editing the tool id will make a new tool, so all other edits to parameters can be
+made and the new tool generated without destroying the original sample.
+
+