Learn R Programming

survPen (version 2.0.1)

Multidimensional Penalized Splines for (Excess) Hazard Models, Relative Mortality Ratio Models and Marginal Intensity Models

Description

Fits (excess) hazard, relative mortality ratio or marginal intensity models with multidimensional penalized splines allowing for time-dependent effects, non-linear effects and interactions between several continuous covariates. In survival and net survival analysis, in addition to modelling the effect of time (via the baseline hazard), one has often to deal with several continuous covariates and model their functional forms, their time-dependent effects, and their interactions. Model specification becomes therefore a complex problem and penalized regression splines represent an appealing solution to that problem as splines offer the required flexibility while penalization limits overfitting issues. Current implementations of penalized survival models can be slow or unstable and sometimes lack some key features like taking into account expected mortality to provide net survival and excess hazard estimates. In contrast, survPen provides an automated, fast, and stable implementation (thanks to explicit calculation of the derivatives of the likelihood) and offers a unified framework for multidimensional penalized hazard and excess hazard models. Later versions (>2.0.0) include penalized models for relative mortality ratio, and marginal intensity in recurrent event setting. survPen may be of interest to those who 1) analyse any kind of time-to-event data: mortality, disease relapse, machinery breakdown, unemployment, etc 2) wish to describe the associated hazard and to understand which predictors impact its dynamics, 3) wish to model the relative mortality ratio between a cohort and a reference population, 4) wish to describe the marginal intensity for recurrent event data. See Fauvernier et al. (2019a) for an overview of the package and Fauvernier et al. (2019b) for the method.

Copy Link

Version

Install

install.packages('survPen')

Monthly Downloads

1,121

Version

2.0.1

License

GPL-3 | file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Mathieu Fauvernier

Last Published

January 21st, 2025

Functions in survPen (2.0.1)

grad_rho

Gradient vector of LCV and LAML wrt rho (log smoothing parameters)
expected.table

French women mortality table
print.summary.survPen

print summary for a survPen fit
instr

Position of the nth occurrence of a string in another one
%vec%

Matrix multiplication between a matrix and a vector
grad_rho_mult

Gradient vector of LCV and LAML wrt rho (log smoothing parameters). Version for multiplicative decomposition : relative mortality ratio model
model.cons

Design and penalty matrices for the model
list.wicss

List of ICSS standards for age-standardization of cancer (net) survival
pwcst

Defining piecewise constant (excess) hazard in survPen formulae
Hess_rho_mult

Hessian matrix of LCV and LAML wrt rho (log smoothing parameters). Version for multiplicative decomposition : relative mortality ratio model
%cross%

Matrix cross-multiplication between two matrices
inv.repam

Reverses the initial reparameterization for stable evaluation of the log determinant of the penalty matrix
Hess_rho

Hessian matrix of LCV and LAML wrt rho (log smoothing parameters)
rd

Defining random effects in survPen formulae
repam

Applies initial reparameterization for stable evaluation of the log determinant of the penalty matrix
predSNS

Prediction of grouped indicators : population (net) survival (PNS) and age-standardized (net) survival (SNS)
summary.survPen

Summary for a survPen fit
survPen

(Excess) hazard model with (multidimensional) penalized splines and integrated smoothness estimation
smooth.spec

Covariates specified as penalized splines
splitmult

Split original dataset at specified times to fit a multiplicative model
smooth.cons

Design and penalty matrices of penalized splines in a smooth.spec object
smooth.cons.integral

Design matrix of penalized splines in a smooth.spec object for Gauss-Legendre quadrature
tensor.prod.X

tensor model matrix
design.matrix

Design matrix for the model needed in Gauss-Legendre quadrature
deriv_R

Derivative of a Choleski factor
predict.survPen

Hazard and Survival prediction from fitted survPen model
tensor.prod.S

Tensor product for penalty matrices
survPen.fit

(Excess) hazard model with multidimensional penalized splines for given smoothing parameters
robust.var

Implementation of the robust variance Vr
smf

Defining smooths in survPen formulae
survPenObject

Fitted survPen object
tensor.in

tensor model matrix for two marginal bases
NR.beta

Inner Newton-Raphson algorithm for regression parameters estimation
CumulHazard

Cumulative hazard (integral of hazard) only
HeartFailure

Patients with heart failure at risk of recurrent hospitalization events
NR.rho

Outer Newton-Raphson algorithm for smoothing parameters estimation via LCV or LAML optimization
colSums2

colSums of a matrix
HazGL

Gauss-Legendre evaluations
constraint

Sum-to-zero constraint
DerivCumulHazard

Cumulative hazard (integral of hazard) and its first and second derivatives wrt regression parameters beta
cor.var

Implementation of the corrected variance Vc
crs

Bases for cubic regression splines (equivalent to "cr" in mgcv)
crs.FP

Penalty matrix constructor for cubic regression splines
datCancer

Patients diagnosed with cervical cancer
%mult%

Matrix multiplication between two matrices