print.matreg: Print and Summary Methods for 'matreg' Objects

View source: R/print.matreg.r

print.matregR Documentation

Print and Summary Methods for 'matreg' Objects

Description

Functions to print objects of class "matreg" and "summary.matreg". \loadmathjax

Usage

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

## S3 method for class 'matreg'
summary(object, digits, ...)

## S3 method for class 'summary.matreg'
print(x, digits, signif.stars=getOption("show.signif.stars"),
      signif.legend=signif.stars, ...)

Arguments

x

an object of class "matreg" or "summary.matreg" (for print).

object

an object of class "matreg" (for summary).

digits

integer to specify the number of decimal places to which the printed results should be rounded. If unspecified, 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 is a table with the estimated coefficients, corresponding standard errors, test statistics, p-values, and confidence interval bounds. When using summary, the output includes additional statistics, including \mjseqnR^2 and the omnibus test of the model coefficients (either an F- or a chi-square test).

Value

The function does not return an object.

Author(s)

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

See Also

matreg for the function to create matreg objects.


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