R: Special functions for use in stat.table

stattable.funs {Epi} | R Documentation

## Special functions for use in stat.table

### Description

These functions may be used as `contents` arguments to the function `stat.table`. They are defined internally in `stat.table` and have no independent existence.

### Usage

    count(id)
    ratio(d,y,scale=1, na.rm=TRUE)
    percent(...)

### Arguments

`id` | numeric vector in which identical values identify the same individual.
`d, y` | numeric vectors of equal length (`d` for Deaths, `y` for person-Years)
`scale` | a scalar giving a value by which the ratio should be multiplied
`na.rm` | a logical value indicating whether `NA` values should be stripped before computation proceeds.
`...` | a list of variables taken from the `index` argument to `stat.table`

### Value

When used as a `contents` argument to `stat.table`, these functions create the following tables:

``count`` | If given without argument (`count()`) it returns a contingency table of counts. If given an `id` argument it returns a table of the number of different values of `id` in each cell, i.e. how many persons contribute in each cell.
``ratio`` | returns a table of values `scale * sum(d)/sum(y)`
``percent`` | returns a table of percentages of the classifying variables. Variables that are in the `index` argument to `stat.table` but not in the call to `percent` are used to define strata, within which the percentages add up to 100.

### Author(s)

Martyn Plummer

### See Also

`stat.table`

[Package Epi version 2.37 Index]