Learn R Programming

⚠️There's a newer version (0.7.3) 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")

Overview

pammtools facilitates the estimation of Piece-wise exponential Additive Mixed Models (PAMMs) for time-to-event data. PAMMs can be represented 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

3,693

Version

0.5.91

License

MIT + file LICENSE

Maintainer

Andreas Bender

Last Published

March 24th, 2023

Functions in pammtools (0.5.91)

compute_cumu_diff

Calculate difference in cumulative hazards and respective standard errors
get_cumu_coef

Extract cumulative coefficients (cumulative hazard differences)
geom_stepribbon

Step ribbon plots.
make_time_mat

Create matrix components for cumulative effects
daily

Time-dependent covariates of the patient data set.
fcumu

A formula special used to handle cumulative effect specifications
dplyr_verbs

dplyr Verbs for ped-Objects
get_event_types

Exctract event types
get_plotinfo

Extract plot information for all special model terms
get_ped_form

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

Calculate CIF for one cause
get_hazard

Calculate predicted hazard
get_laglead

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

Information on intervals in which times fall
get_cumulative

Expand time-dependent covariates to functionals
get_cut

Obtain interval break points
gg_partial

Visualize effect estimates for specific covariate combinations
gg_re

Plot Normal QQ plots for random effects
get_cumu_eff

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

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

(Cumulative) (Step-) Hazard Plots.
gg_fixed

Forrest plot of fixed coefficients
get_sim_ci

Calculate simulation based confidence intervals
get_surv_prob

Calculate survival probabilities
get_cumu_hazard

Calculate cumulative hazard
gg_laglead

Plot Lag-Lead windows
get_tdc_form

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

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

Plot 1D (smooth) effects
pammtools

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

Extract information on concurrent effects
pamm

Fit a piece-wise exponential additive model
get_terms

Extract the partial effects of non-linear model terms
gg_tensor

Plot tensor product effects
gg_smooth

Plot smooth 1d terms of gam objects
get_term

Extract partial effects for specified model terms
warn_about_new_time_points

Warn if new t_j are used
ped_info

Extract interval information and median/modus values for covariates
make_newdata

Construct a data frame suitable for prediction
has_tdc

Checks if data contains timd-dependent covariates
nest_tdc

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

Stomach area tumor data
patient

Survival data of critically ill ICU patients
sim_pexp

Simulate survival times from the piece-wise exponential distribution
split_data

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

Pipe operator
rpexp

Draw random numbers from piece-wise exponential distribution.
cumulative

Formula specials for defining time-dependent covariates
tidy_smooth

Extract 1d smooth objects in tidy data format.
predictSurvProb.pamm

S3 method for pamm objects for compatibility with package pec
tidy_fixed

Extract fixed coefficient table from model object
simdf_elra

Simulated data with cumulative effects
tidy_re

Extract random effects in tidy data format.
tidy_smooth2d

Extract 2d smooth objects in tidy format.
modus

Calculate the modus
int_info

Create start/end times and interval information
sample_info

Extract information of the sample contained in a data set
seq_range

Generate a sequence over the range of a vector
staph

Time until staphylococcus aureaus infection in children, with possible recurrence
split_data_recurrent

Split data to obtain recurrent event data in PED format
add_surv_prob

Add survival probability estimates
as_ped

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

Add cumulative incidence function to data
add_term

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

Add time-dependent covariate to a data set
as.data.frame.crps

Transform crps object to data.frame
add_hazard

Add predicted (cumulative) hazard to data set
combine_df

Create a data frame from all combinations of data frames
calc_ci

Calculate confidence intervals
as_ped_cr

Competing risks trafo