print.regtest.rma: Print Method for 'regtest' Objects

print.regtestR Documentation

Print Method for 'regtest' Objects

Description

Function to print objects of class "regtest".

Usage

## S3 method for class 'regtest'
print(x, digits=x$digits, ret.fit=x$ret.fit, ...)

Arguments

x

an object of class "regtest" obtained with regtest.

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).

ret.fit

logical to specify whether the full results from the fitted model should also be returned. If unspecified, the default is to take the value from the object.

...

other arguments.

Details

The output includes:

  • the model used for the regression test

  • the predictor used for the regression test

  • the results from the fitted model (only when ret.fit=TRUE)

  • the test statistic of the test that the predictor is unreleated to the outcomes

  • the degrees of freedom of the test statistic (only if the test statistic follows a t-distribution)

  • the corresponding p-value

  • the ‘limit estimate’ and its corresponding CI (only for predictors "sei" "vi", "ninv", or "sqrtninv" and when the model does not contain any additional moderators)

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

regtest for the function to create regtest objects.


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