is.ratetable: Verify that an object is of class ratetable.
In survival: Survival Analysis
is.ratetable 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 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.
Examples
is.ratetable(survexp.us) # True
is.ratetable(lung) # False
survival documentation built on June 22, 2024, 10:49 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| is.ratetable | 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
pyears, survexp.
Examples
is.ratetable(survexp.us) # True
is.ratetable(lung) # False
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.