R/terminal.R

In frailtypack: Shared, Joint (Generalized) Frailty Models; Surrogate Endpoints

#' Identify terminal indicator
#' 
#' This is a special function used in the context of recurrent event models
#' with terminal event (e.g., censoring variable related to recurrent events).
#' It contains the status indicator, normally 0=alive, 1=dead, and is used on
#' the right hand side of a formula of a 'frailtyPenal', 'longiPenal' and
#' 'trivPenal' functions.  Using \code{terminal()} in a formula implies that a
#' joint frailty model for recurrent events and terminal events is fitted.
#' 
#' 
#' @usage terminal(x)
#' @param x A numeric variable but should be a Boolean which equals 1 if the
#' subject is dead and 0 if he is alive or censored, as a death indicator.
#' @return \item{x}{a death indicator}
#' @seealso \code{\link{frailtyPenal}}
#' @export
#' @keywords misc
"terminal"<-function(x)
 {
  x
 }