papaja (version 0.1.0.9655)

apa_print.glht: Format statistics (APA 6th edition)

Description

Takes various lsmeans objects methods to create formatted character strings to report the results in accordance with APA manuscript guidelines. These methods are not properly tested and should be considered experimental.

Usage

apa_print.glht(x, test = multcomp::adjusted(), ...)
apa_print.summary.glht(x, ci = 0.95, in_paren = FALSE, ...)
apa_print.lsmobj(x, ...)
apa_print.summary.ref.grid(x, contrast_names = NULL, in_paren = FALSE, ...)

Arguments

x

See details.

test

Function.

...

Further arguments to pass to printnum to format the estimate.

ci

Numeric. If NULL (default) the function tries to obtain confidence intervals from x. Other confidence intervals can be supplied as a vector of length 2 (lower and upper boundary, respectively) with attribute conf.level, e.g., when calculating bootstrapped confidence intervals.

in_paren

Logical. Indicates if the formated string will be reported inside parentheses.

contrast_names

Character. A vector of names to identify calculated contrasts.

Value

apa_print() returns a list containing the following components according to the input:

statistic

A character string giving the test statistic, parameters (e.g., degrees of freedom), and p value.

estimate

A character string giving the descriptive estimates and confidence intervals if possible

% , either in units of the analyzed scale or as standardized effect size.

full_result

A joint character string comprised of est and stat.

table

A data.frame containing the complete contrast table, which can be passed to apa_table.

Details

The function should work on a wide range of htest objects. Due to the large number of functions that produce these objects and their idiosyncrasies, the produced strings may sometimes be inaccurate. If you experience inaccuracies you may report these here (please include a reproducible example in your report!).

ADJUSTED CONFIDENCE INTERVALS

stat_name and est_name are placed in the output string and are thus passed to pandoc or LaTeX through kntir. Thus, to the extent it is supported by the final document type, you can pass LaTeX-markup to format the final text (e.g., \\tau yields \(\tau\)).

If in_paren is TRUE parentheses in the formated string, such as those surrounding degrees of freedom, are replaced with brackets.

See Also

Other apa_print: apa_print.BFBayesFactor, apa_print.aov, apa_print.glm, apa_print.htest, apa_print.list, apa_print

Examples

# NOT RUN {
   NULL
# }