tidy_survfit

The broom package exports a tidier for <code>"survfit"</code> objects.
This function adds on top of that and returns more information.
The function also utilizes additional information stored when the
survfit object is created with <code>survfit2()</code>.
It's recommended to always use this function with <code>survfit2()</code>.

Ease the creation of time-to-event (i.e. survival) endpoint
figures. The modular functions create figures ready for publication.
Each of the functions that add to or modify the figure are written as
proper 'ggplot2' geoms or stat methods, allowing the functions from
this package to be combined with any function or customization from
'ggplot2' and other 'ggplot2' extension packages.

Daniel D. Sjoberg

ggsurvfit

Flexible Time-to-Event Figures

Mark Baillie

Charlotta Fruechtenicht

Steven Haesendonckx

Tim Treis

tidy_survfit function

<dl><dt>x</dt>
<dd>a 'survfit' object created with <code>survfit2()</code></dd>
<dt>times</dt>
<dd>numeric vector of times. Default is <code>NULL</code>,
which returns all observed times.</dd>
<dt>type</dt>
<dd>type of statistic to report.
Available for Kaplan-Meier estimates only.
Default is <code>"survival"</code>.
Must be one of the following or a function:<table class="table">
<tr><td>type</td><td>transformation</td></tr>
<tr><td><code>"survival"</code></td><td><code>x</code></td></tr>
<tr><td><code>"risk"</code></td><td><code>1 - x</code></td></tr>
<tr><td><code>"cumhaz"</code></td><td><code>-log(x)</code></td></tr>
<tr><td><code>"cloglog"</code></td><td><code>log(-log(x))</code></td></tr>
</table>
</dd></dl>

Arguments

Tidy a survfit object — tidy_survfit

<dl>

<dt>x</dt>
<dd>a 'survfit' object created with <code>survfit2()</code></dd>


<dt>times</dt>
<dd>numeric vector of times. Default is <code>NULL</code>,
which returns all observed times.</dd>


<dt>type</dt>
<dd>type of statistic to report.
Available for Kaplan-Meier estimates only.
Default is <code>"survival"</code>.
Must be one of the following or a function:<table class='table'>
<tr><td>type</td><td>transformation</td></tr>
<tr><td><code>"survival"</code></td><td><code>x</code></td></tr>
<tr><td><code>"risk"</code></td><td><code>1 - x</code></td></tr>
<tr><td><code>"cumhaz"</code></td><td><code>-log(x)</code></td></tr>
<tr><td><code>"cloglog"</code></td><td><code>log(-log(x))</code></td></tr>
</table>
</dd>

</dl>

type	transformation
`"survival"`	`x`
`"risk"`	`1 - x`
`"cumhaz"`	`-log(x)`
`"cloglog"`	`log(-log(x))`

tidy_survfit: Tidy a survfit object

Description

Usage

Value

Arguments

Examples