arsenal: tableby.internal – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

arsenal

tableby.internal

Helper functions for tableby

Description

A set of helper functions for tableby.

Usage

is.tableby(x)

is.summary.tableby(x)

modpval.tableby(x, pdata, use.pname = FALSE)

tests(x)

## S3 method for class 'tableby'
tests(x)

na.tableby(lhs = TRUE)

## S3 method for class 'tableby'
xtfrm(x)

## S3 method for class 'tableby'
sort(x, ...)

## S3 method for class 'tableby'
Ops(e1, e2)

## S3 method for class 'tableby'
head(x, n = 6L, ...)

## S3 method for class 'tableby'
tail(x, n = 6L, ...)

Arguments

`x`	A `tableby` object.
`pdata`	A named data.frame where the first column is the by-variable names, the (optional) second is the strata value, the next is the x variable names, the next is p-values (or some test stat), and the (optional) next column is the method name.
`use.pname`	Logical, denoting whether the column name in `pdata` corresponding to the p-values should be used in the output of the object.
`lhs`	Logical, denoting whether to remove `NA`s from the first column of the data.frame (the "left-hand side")
`...`	Other arguments.
`e1, e2`	`tableby` objects, or numbers to compare them to.
`n`	A single integer. See `head` or `tail` for more details

Details

Logical comparisons are implemented for Ops.tableby.

Value

na.tableby returns a subsetted version of object (with attributes). Ops.tableby returns a logical vector. xtfrm.tableby returns the p-values (which are ordered by order to sort).