Learn R Programming

plsRcox (version 1.0)

coxsplsDR: Fitting a sPLSR model on the (Deviance) Residuals

Description

This function computes the sPLSR model with the Residuals of a Cox-Model fitted with an intercept as the only explanatory variable as the response and Xplan as explanatory variables. Default behaviour uses the Deviance residuals. It uses the package pls.

Usage

coxsplsDR(Xplan, ...)
## S3 method for class 'default':
coxsplsDR(Xplan, time, time2, event, type, 
origin, typeres = "deviance", collapse, weighted, scaleX = TRUE, 
scaleY = TRUE, ncomp=min(7,ncol(Xplan)), modepls="regression", 
plot = FALSE, allres = FALSE, eta, trace=FALSE,...)
## S3 method for class 'formula':
coxsplsDR(Xplan,time,time2,event,type,
origin,typeres="deviance", collapse, weighted, scaleX=TRUE, 
scaleY=TRUE, ncomp=min(7,ncol(Xplan)), modepls="regression", 
plot=FALSE, allres=FALSE,dataXplan=NULL,subset,weights,
model_frame=FALSE,eta, trace=FALSE,...)

Arguments

Xplan
a formula or a matrix with the eXplanatory variables (training) dataset
time
for right censored data, this is the follow up time. For interval data, the first argument is the starting time for the interval.
time2
The status indicator, normally 0=alive, 1=dead. Other choices are TRUE/FALSE (TRUE = death) or 1/2 (2=death). For interval censored data, the status indicator is 0=right censored, 1=event at time, 2=left censored, 3=
event
ending time of the interval for interval censored or counting process data only. Intervals are assumed to be open on the left and closed on the right, (start, end]. For counting process data, event indicates whether an event occurred at the e
type
character string specifying the type of censoring. Possible values are "right", "left", "counting", "interval", or "interval2". The default is "right" or "counting"
origin
for counting process data, the hazard function origin. This option was intended to be used in conjunction with a model containing time dependent strata in order to align the subjects properly when they cross over from one strata to another, but it has rar
typeres
character string indicating the type of residual desired. Possible values are "martingale", "deviance", "score", "schoenfeld", "dfbeta", "dfbetas", and "scaledsch".
collapse
vector indicating which rows to collapse (sum) over. In time-dependent models more than one row data can pertain to a single individual. If there were 4 individuals represented by 3, 1, 2 and 4 rows of data respectively, then collapse=c(1,1,1,2,3,3,
weighted
if TRUE and the model was fit with case weights, then the weighted residuals are returned.
scaleX
Should the Xplan columns be standardized ?
scaleY
Should the time values be standardized ?
ncomp
The number of components to include in the model. The number of components to fit is specified with the argument ncomp. It this is not supplied, the maximal number of components is used.
modepls
character string. What type of algorithm to use, (partially) matching one of "regression", "canonical", "invariant" or "classic". See pls for details
plot
Should the survival function be plotted ?)
allres
FALSE to return only the Cox model and TRUE for additionnal results. See details. Defaults to FALSE.
dataXplan
an optional data frame, list or environment (or object coercible by as.data.frame to a data frame) containing the variables in the model. If not found in dataXplan, the variables are take
subset
an optional vector specifying a subset of observations to be used in the fitting process.
weights
an optional vector of 'prior weights' to be used in the fitting process. Should be NULL or a numeric vector.
model_frame
If TRUE, the model frame is returned.
eta
Thresholding parameter. eta should be between 0 and 1.
trace
Print out the progress of variable selection?
...
Arguments to be passed on to survival::coxph.

Value

  • If allres=FALSE :
  • cox_splsDRFinal Cox-model.
  • If allres=TRUE :
  • tt_splsDRsPLSR components.
  • cox_splsDRFinal Cox-model.
  • splsDR_modThe sPLSR model.

Details

If allres=FALSE returns only the final Cox-model. If allres=TRUE returns a list with the sPLS components, the final Cox-model and the sPLSR model. allres=TRUE is useful for evluating model prediction accuracy on a test sample.

References

plsRcox : mod?les{mod`eles} de Cox en pr?sence{pr'esence} d'un grand nombre de variables explicatives, Fr?d?ric{Fr'ed'eric} Bertrand, Myriam Maumy-Bertrand, Marie-Pierre Gaub, Nicolas Meyer, Chimiom?trie{Chimiom'etrie} 2010, Paris, 2010.

See Also

coxph, plsr

Examples

Run this code
data(micro.censure)
data(Xmicro.censure_compl_imp)

X_train_micro <- apply((as.matrix(Xmicro.censure_compl_imp)),FUN="as.numeric",MARGIN=2)[1:80,]
X_train_micro_df <- data.frame(X_train_micro)
Y_train_micro <- micro.censure$survyear[1:80]
C_train_micro <- micro.censure$DC[1:80]

(cox_splsDR_fit=coxsplsDR(X_train_micro,Y_train_micro,C_train_micro,ncomp=6,eta=.5))
(cox_splsDR_fit2=coxsplsDR(~X_train_micro,Y_train_micro,C_train_micro,ncomp=6,eta=.5,trace=TRUE))
(cox_splsDR_fit3=coxsplsDR(~.,Y_train_micro,C_train_micro,ncomp=6,
dataXplan=X_train_micro_df,eta=.5))

rm(X_train_micro,Y_train_micro,C_train_micro,cox_splsDR_fit,cox_splsDR_fit2,cox_splsDR_fit3)

Run the code above in your browser using DataLab