is.ratetable {survival} | R Documentation |
Verify that an object is of class ratetable.
Description
The function verifies not only the class
attribute, but the
structure of the object.
Usage
is.ratetable(x, verbose=FALSE)
Arguments
x |
the object to be verified. |
verbose |
if |
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
Examples
is.ratetable(survexp.us) # True
is.ratetable(lung) # False
[Package survival version 3.8-3 Index]