Generate the basis matrix for cubic regression splines with penalties on the second derivatives.
cr(x, df=10, knots=NULL, intercept=FALSE, fx= FALSE, S=NULL)
the predictor variable. Missing values are allowed.
degrees of freedom, basically the dimension of the basis matrix. If supplied in the absence of knots
, it automatically selects df+1-intercept
knots at equally-spaced quantiles of x
. The minimum allowed is df=3
.
breakpoints that define the spline. These are generally automatically selected, and not defined by the user. See Details below.
logical. If TRUE
, an intercept is included in the basis matrix. See Details below.
logical. If TRUE
, it removes the penalization. See Details below.
penalty matrix, usually internally defined if NULL
(default).
A matrix object of class "cr"
. It contains the attributes df
, knots
, intercept
, fx
, and S
, with values that can be different than the arguments provided due to internal reset.
The function has a usage similar to bs
and ns
in the splines package. It produces spline transformations, however using a parameterization that represents the splines fit in terms of values at the knots. A penalty matrix is also defined. The same results are returned by the related smooth constructor
in the package mgcv, which is in fact called internally.
The argument knots
defines a vector of knots within the range of the predictor x
, by default at equally-spaced quantiles. The penalization is defined on the second derivative of the function through a penalty matrix S
.
Similarly to bs
and ns
, setting intercept=FALSE
(default) determines the exclusion of the first transformed variables, and the corresponding first row and column in S
, thus avoiding identifiability issues during the model fitting. Note how the procedure of imposing identifiability constraints is different from that adopted by smoothCon
in the package mgcv, where a more complex reparameterization is produced.
Gasparrini A, Scheipl F, Armstrong B, Kenward MG. A penalized framework for distributed lag non-linear models. Biometrics. 2017;73(3):938-948. [freely available here]
Wood S. N. Generalized Additive Models: An Introduction with R. Chapman and Hall/CRC Press, 2006.
ps
for P-splines. bs
and ns
for B-splines and natural cubic splines, respectively. cbPen
for defining tensor-type bi-dimensional penalties in DLNMs. The related smooth constructor
for cubic regression spline smooths in mgcv. The cb smooth constructor
for cross-basis penalized spline smooths.
See dlnm-package
for an introduction to the package and for links to package vignettes providing more detailed information.
# NOT RUN {
# to be added soon
# }
Run the code above in your browser using DataLab