paired {arsenal} | R Documentation |
Summary Statistics of a Set of Independent Variables Paired Across Two Timepoints
Description
Summarize one or more variables (x) by a paired time variable (y). Variables on the right side of the formula, i.e. independent variables, are summarized by the two time points on the left of the formula. Optionally, an appropriate test is performed to test the distribution of the independent variables across the time points.
Usage
paired(
formula,
data,
id,
na.action,
subset = NULL,
strata,
control = NULL,
...
)
Arguments
formula |
an object of class |
data |
an optional data frame, list or environment (or object coercible by |
id |
The vector giving IDs to match up data for the same subject across two timepoints. |
na.action |
a function which indicates what should happen when the data contain |
subset |
an optional vector specifying a subset of observations (rows of data) to be used in the results. Works as vector of logicals or an index. |
strata |
a vector of strata to separate summaries by an additional group. |
control |
control parameters to handle optional settings within |
... |
additional arguments to be passed to internal |
Details
Do note that this function piggybacks off of tableby
quite heavily, so there is no
summary.paired
function (for instance).
These tests are accepted:
-
paired.t
: a pairedt-test
. -
mcnemar
: McNemar's test. -
signed.rank
: a signed rank test. -
sign.test
: a sign test. -
notest
: no test is performed.
Value
An object with class c("paired", "tableby", "arsenal_table")
Author(s)
Jason Sinnwell, Beth Atkinson, Ryan Lennon, and Ethan Heinzen
See Also
arsenal_table
, paired.control
, tableby
, formulize
, selectall