R/print.predictCSC.R

### print.predictCSC.R --- 
#----------------------------------------------------------------------
## author: Thomas Alexander Gerds
## created: Feb 11 2017 (10:01) 
## Version: 
## last-updated: jun  1 2018 (13:37) 
##           By: Brice Ozenne
##     Update #: 75
#----------------------------------------------------------------------
## 
### Commentary: 
## 
### Change Log:
#----------------------------------------------------------------------
## 
### Code:

## * print.predictCSC (documentation)
#' @title Print Predictions From a Cause-specific Cox Proportional Hazard Regression
#' @description Print predictions from a Cause-specific Cox proportional hazard regression.
#' @name print.predictCSC
#' 
#' @param x object obtained with the function \code{predictCox}.
#' @param digits [integer, >0] indicating the number of decimal places.
#' @param ... Passed to print.
#' 
#' @details to display confidence intervals/bands,
#' the \code{confint} method needs to be applied on the object.
#'
#' @seealso
#' \code{\link{confint.predictCSC}} to compute confidence intervals/bands.
#' \code{\link{predict.CauseSpecificCox}} to compute the predicted risks.

## * print.predictCSC (code)
#' @rdname print.predictCSC
#' @method print predictCSC
#' @export
print.predictCSC <- function(x, digits = 3, ...){
        out <- as.data.table(x)
        print(out,digits=digits,...)
        invisible(out)
}

#----------------------------------------------------------------------
### print.predictCSC.R ends here
bozenne/riskRegressionLight documentation built on May 7, 2019, 12:52 a.m.