print.permutest.rma.uni: Print Method for 'permutest.rma.uni' Objects

View source: R/print.permutest.rma.uni.r

print.permutest.rma.uniR Documentation

Print Method for 'permutest.rma.uni' Objects

Description

Function to print objects of class "permutest.rma.uni".

Usage

## S3 method for class 'permutest.rma.uni'
print(x, digits=x$digits, signif.stars=getOption("show.signif.stars"),
      signif.legend=signif.stars, ...)

Arguments

x

an object of class "permutest.rma.uni" obtained with permutest.

digits

integer to specify the number of decimal places to which the printed results should be rounded (the default is to take the value from the object).

signif.stars

logical to specify whether p-values should be encoded visually with ‘significance stars’. Defaults to the show.signif.stars slot of options.

signif.legend

logical to specify whether the legend for the ‘significance stars’ should be printed. Defaults to the value for signif.stars.

...

other arguments.

Details

The output includes:

  • the results of the omnibus test of moderators. Suppressed if the model includes only one coefficient (e.g., only an intercept, like in the equal- and random-effects models). The p-value is based on the permutation test.

  • a table with the estimated coefficients, corresponding standard errors, test statistics, p-values, and confidence interval bounds. The p-values are based on permutation tests. If permci was set to TRUE, then the permutation-based CI bounds are shown.

Value

The function does not return an object.

Author(s)

Wolfgang Viechtbauer (wvb@metafor-project.org, https://www.metafor-project.org).

References

Viechtbauer, W. (2010). Conducting meta-analyses in R with the metafor package. Journal of Statistical Software, 36(3), 1–48. ⁠https://doi.org/10.18637/jss.v036.i03⁠

See Also

permutest for the function to create permutest.rma.uni objects.


wviechtb/metafor documentation built on Dec. 4, 2024, 1:03 a.m.