Learn R Programming

⚠️There's a newer version (0.7.4) of this package.Take me there.

pammtools: Piece-Wise Exponential Additive Mixed Modeling Tools

Installation

Install from CRAN or GitHub using:

# CRAN
install.packages("pammtools")

# GitHub
devtools::install_github("adibender/pammtools")

Overview

pammtools facilitates the estimation of Piece-wise exponential Additive Mixed Models (PAMMs) for time-to-event data. PAMMs can be represeted as generalized additive models and can therefore be estimated using GAM software (e.g. mgcv), which, compared to other packages for survival analysis, often offers more flexibility w.r.t. to the specification of covariate effects (e.g. non-linear, time-varying effects, cumulative effects, etc.).

To get started, see the Articles section.

Copy Link

Version

Install

install.packages('pammtools')

Monthly Downloads

5,663

Version

0.1.14

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Andreas Bender

Last Published

September 8th, 2019

Functions in pammtools (0.1.14)

add_term

Embeds the data set with the specified (relative) term contribution
calc_ci

Calculate confidence intervals
combine_df

Create a data frame from all combinations of data frames
compute_cumu_diff

Calculate difference in cumulative hazards and respective standard errors
as_ped

Transform data to Piece-wise Exponential Data (PED)
add_tdc

Add time-dependent covariate to a data set
add_hazard

Add predicted (cumulative) hazard to data set
get_cumu_coef

Extract cumulative coefficients (cumulative hazard differences)
combine_cut

Extract unique cut points when time-dependent covariates present
add_surv_prob

Add survival probability estimates
fcumu

A formula special used to handle cumulative effect specifications
gg_slice

Plot 1D (smooth) effects
gg_tensor

Plot tensor product effects
geom_stepribbon

Step ribbon plots.
get_cumulative

Expand time-dependent covariates to functionals
gg_smooth

Plot smooth 1d terms of gam objects
geom_hazard

(Cumulative) (Step-) Hazard Plots.
get_cumu_hazard

Calculate cumulative hazard
gg_re

Plot Normal QQ plots for random effects
split_data

Function to transform data without time-dependent covariates into piece-wise exponential data format
get_ped_form

Extract variables from the left-hand-side of a formula
get_cumu_coef_baseline

Extract cumulative coefficients (cumulative hazard differences)
get_hazard

Calculate predicted hazard
extub_event

Time until extubation
make_time_mat

Create matrix components for cumulative effects
get_cut

Obtain interval break points
make_newdata

Construct a data frame suitable for prediction
get_cumu_eff

Calculate (or plot) cumulative effect for all time-points of the follow-up
get_surv_prob

Calculate survival probabilities
get_tdc

Extract time-dependent covariates from data set
get_sim_ci

Calculate simulation based confidence intervals
get_lhs_vars

Extract variables from the left-hand-side of a formula
get_plotinfo

Extract plot information for all special model terms
tidy_smooth

Extract 1d smooth objects in tidy data format.
pammtools

pammtools: Piece-wise exponential Additive Mixed Modeling tools.
gg_laglead

Plot Lag-Lead windows
gg_partial

Visualize effect estimates for specific covariate combinations
get_tdc_vars

Extract variables from the left-hand-side of a formula
daily

dplyr_verbs

dplyr Verbs for ped-Objects
get_term

Extract partial effects for specified model terms
ped_info

Extract interval information and median/modus values for covariates
patient

Survival data of critically ill ICU patients
simdf_elra

Simulated data with cumulative effects
get_intervals

Information on intervals in which times fall
riskset_info

Extract risk set information for each interval.
get_laglead

Construct or extract data that represents a lag-lead window
sample_info

Extract information of the sample contained in a data set
gg_fixed

Forrest plot of fixed coefficients
int_info

Create start/end times and interval information
has_tdc

Extract time-dependent covariates from data set
get_terms

Extract the partial effects of non-linear model terms
%>%

Pipe operator
prep_concurrent

Extract information on concurrent effects
tidy_smooth2d

Extract 2d smooth objects in tidy format.
tidyr_verbs

tidyr Verbs for ped-Objects
cumulative

Formula specials for defining time-dependent covariates
tidy_fixed

Extract fixed coefficient table from model object
tidy_re

Extract random effects in tidy data format.
warn_about_new_time_points

Warn if new t_j are used
tumor

Stomach area tumor data
get_tdc_form

Extract variables from the left-hand-side of a formula
modus

Calculate the modus
nest_tdc

Create nested data frame from data with time-dependent covariates
seq_range

Generate a sequence over the range of a vector
sim_pexp

Simulate survival times from the piece-wise exponential distribution