is.ratetable

0th

Percentile

Verify that an object is of class ratetable.

The function verifies not only the class attribute, but the structure of the object.

Keywords
survival
Usage
is.ratetable(x, verbose=FALSE)
Arguments
x

the object to be verified.

verbose

if TRUE and the object is not a ratetable, then return a character string describing the way(s) in which x fails to be a proper ratetable object.

Details

Rate tables are used by the pyears and survexp functions, and normally contain death rates for some population, categorized by age, sex, or other variables. They have a fairly rigid structure, and the verbose option can help in creating a new rate table.

Value

returns TRUE if x is a ratetable, and FALSE or a description if it is not.

See Also

pyears, survexp.

Aliases
  • is.ratetable
  • Math.ratetable
  • Ops.ratetable
Examples
# NOT RUN {
is.ratetable(survexp.us)  # True
is.ratetable(cancer)      # False
# }
Documentation reproduced from package survival, version 3.1-8, License: LGPL (>= 2)

Community examples

Looks like there are no examples yet.