censoring: Describe Censoring

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

Describe Censoring

Description

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

Usage

censoring(x)

## Default S3 method:
censoring(x)

## S3 method for class 'lcens'
censoring(x)

## S3 method for class 'mcens'
censoring(x)

## S3 method for class 'qw'
censoring(x)

Arguments

x	the object to get the type of censoring.

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.

See Also

censorLevels

Examples

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

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