annotate lifelines_tool/README.md @ 0:dd49a7040643 draft

Initial commit
author fubar
date Wed, 09 Aug 2023 11:12:16 +0000
parents
children 232b874046a7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dd49a7040643 Initial commit
fubar
parents:
diff changeset
1 # lifelines_tool - lifelines statistical package wrapped as a Galaxy tool.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
2
dd49a7040643 Initial commit
fubar
parents:
diff changeset
3 ## Galaxy tool to run failure time models using lifelines
dd49a7040643 Initial commit
fubar
parents:
diff changeset
4
dd49a7040643 Initial commit
fubar
parents:
diff changeset
5 ## Install to your Galaxy server from the toolshed - search for lifelines_tool owned by fubar2
dd49a7040643 Initial commit
fubar
parents:
diff changeset
6
dd49a7040643 Initial commit
fubar
parents:
diff changeset
7 ### More at https://lazarus.name/demo/
dd49a7040643 Initial commit
fubar
parents:
diff changeset
8
dd49a7040643 Initial commit
fubar
parents:
diff changeset
9 #### Using the Rossi sample input data from lifelines, tool outputs include:
dd49a7040643 Initial commit
fubar
parents:
diff changeset
10
dd49a7040643 Initial commit
fubar
parents:
diff changeset
11 ![KM plot sample](lifelines_rossi_km.png)
dd49a7040643 Initial commit
fubar
parents:
diff changeset
12 and
dd49a7040643 Initial commit
fubar
parents:
diff changeset
13 ![KM plot sample](lifelines_rossi_schoenfeld.png)
dd49a7040643 Initial commit
fubar
parents:
diff changeset
14 and
dd49a7040643 Initial commit
fubar
parents:
diff changeset
15 ![KM plot sample](lifelines_report.png)
dd49a7040643 Initial commit
fubar
parents:
diff changeset
16
dd49a7040643 Initial commit
fubar
parents:
diff changeset
17
dd49a7040643 Initial commit
fubar
parents:
diff changeset
18 Runs Kaplan-Meier and generates a plot. Optional grouping variable.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
19 If 2 groups, runs a log-rank test for difference.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
20 Plots show confidence intervals
dd49a7040643 Initial commit
fubar
parents:
diff changeset
21
dd49a7040643 Initial commit
fubar
parents:
diff changeset
22 If a list of covariate column names is provided, these are used in a
dd49a7040643 Initial commit
fubar
parents:
diff changeset
23 Cox Proportional Hazards model with tests for proportionality.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
24
dd49a7040643 Initial commit
fubar
parents:
diff changeset
25 Should work with any tabular data with the required columns - time and status for observations.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
26
dd49a7040643 Initial commit
fubar
parents:
diff changeset
27 Issues to https://github.com/fubar2/lifelines_tool please.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
28 Autogenerated so pull requests are possibly meaningless but regeneration of a new version is easy so please tell me what is needed.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
29
dd49a7040643 Initial commit
fubar
parents:
diff changeset
30 ## Tool made with the Galaxy ToolFactory: https://github.com/fubar2/galaxy_tf_overlay
dd49a7040643 Initial commit
fubar
parents:
diff changeset
31 The current release includes this and a generic tabular version, and a java .jar wrapper in a history where the generating
dd49a7040643 Initial commit
fubar
parents:
diff changeset
32 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
dd49a7040643 Initial commit
fubar
parents:
diff changeset
33 made and the new tool generated without destroying the original sample.
dd49a7040643 Initial commit
fubar
parents:
diff changeset
34
dd49a7040643 Initial commit
fubar
parents:
diff changeset
35