censoring.Surv: Describe Censoring

Description Usage Arguments Value Note Examples

View source: R/censoring.Surv.R

Description

Gets the type of censoring ("none," "left," "multiple") for an object.

Usage

1
2
## S3 method for class 'Surv'
censoring(x)

Arguments

x

the object to get the type of censoring. For an object of class "Surv," the type must be "interval."

Value

A character string "none," "left," or "multiple" describing the type of censoring present in the object.

Note

This function is mostly used within other functions to determine the 'best' technique to use for analysis.

Examples

1
2
3
4
5
## Not run: 
library(survival)
censoring(Surv(2.3, 2.3, type="interval2"))

## End(Not run)

USGS-R/rloadest documentation built on Oct. 2, 2020, 5:21 a.m.