censorLevels: Describe Censoring

In USGS-R/smwrQW: Tools for censored data analysis

Describe Censoring

Description

Returns all censoring levels for an object.

Usage

censorLevels(x, type = "left")

## Default S3 method:
censorLevels(x, type = "left")

## S3 method for class 'lcens'
censorLevels(x, type = "left")

## S3 method for class 'mcens'
censorLevels(x, type = "left")

## S3 method for class 'qw'
censorLevels(x, type = "left")

Arguments

x	the object to get the levels of censoring.
type	a character string indicating the type of censoring levels, must be either "left" or "right."

Value

A numeric vector of the sorted censoring levels. If all data are uncensored, then -Inf is returned for type = "left" and Inf is returned for type = "right."

Note

Interval censoring is not characterized by a single value, so it is not an option for type.

See Also

censoring

Examples

censorLevels(2.3) # a simple number
censorLevels(as.lcens(1, 2)) # left-censored 

USGS-R/smwrQW documentation built on Oct. 11, 2022, 6:13 a.m.