print.meta: Print meta-analysis results

View source: R/print.meta.R

print.metaR Documentation

Print meta-analysis results

Description

Print method for objects of class meta.

R function cilayout can be utilised to change the layout to print confidence intervals (both in printout from print.meta and print.summary.meta function as well as in forest plots). The default layout is "[lower; upper]". Another popular layout is "(lower - upper)" which is used throughout an R session by using R command cilayout("(", " - ").

Argument pscale can be used to rescale single proportions or risk differences, e.g. pscale = 1000 means that proportions are expressed as events per 1000 observations. This is useful in situations with (very) low event probabilities.

Argument irscale can be used to rescale single rates or rate differences, e.g. irscale = 1000 means that rates are expressed as events per 1000 time units, e.g. person-years. This is useful in situations with (very) low rates. Argument irunit can be used to specify the time unit used in individual studies (default: "person-years"). This information is printed in summaries and forest plots if argument irscale is not equal to 1.

Usage

## S3 method for class 'meta'
print(
  x,
  common = x$common,
  random = x$random,
  prediction = x$prediction,
  overall = x$overall,
  overall.hetstat = x$overall.hetstat,
  test.subgroup = x$test.subgroup,
  test.subgroup.common = test.subgroup & common,
  test.subgroup.random = test.subgroup & random,
  prediction.subgroup = x$prediction.subgroup,
  backtransf = x$backtransf,
  pscale = x$pscale,
  irscale = x$irscale,
  irunit = x$irunit,
  subgroup.name = x$subgroup.name,
  print.subgroup.name = x$print.subgroup.name,
  sep.subgroup = x$sep.subgroup,
  nchar.subgroup = 35,
  header = TRUE,
  print.CMH = x$print.CMH,
  digits = gs("digits"),
  digits.stat = gs("digits.stat"),
  digits.pval = max(gs("digits.pval"), 2),
  digits.pval.Q = max(gs("digits.pval.Q"), 2),
  digits.Q = gs("digits.Q"),
  digits.tau2 = gs("digits.tau2"),
  digits.tau = gs("digits.tau"),
  digits.H = gs("digits.H"),
  digits.I2 = gs("digits.I2"),
  scientific.pval = gs("scientific.pval"),
  big.mark = gs("big.mark"),
  zero.pval = gs("zero.pval"),
  JAMA.pval = gs("JAMA.pval"),
  digits.df = gs("digits.df"),
  print.tau2 = TRUE,
  print.tau = TRUE,
  print.I2 = gs("print.I2"),
  print.H = gs("print.H"),
  print.Rb = gs("print.Rb"),
  text.tau2 = gs("text.tau2"),
  text.tau = gs("text.tau"),
  text.I2 = gs("text.I2"),
  text.Rb = gs("text.Rb"),
  details.methods = TRUE,
  warn.backtransf = FALSE,
  warn.deprecated = gs("warn.deprecated"),
  ...
)

cilayout(
  bracket = gs("CIbracket"),
  separator = gs("CIseparator"),
  lower.blank = gs("CIlower.blank"),
  upper.blank = gs("CIupper.blank")
)

Arguments

x

An object of class meta.

common

A logical indicating whether results for common effect meta-analysis should be printed.

random

A logical indicating whether results for random effects meta-analysis should be printed.

prediction

A logical indicating whether a prediction interval should be printed.

overall

A logical indicating whether overall summaries should be reported. This argument is useful in a meta-analysis with subgroups if overall results should not be reported.

overall.hetstat

A logical value indicating whether to print heterogeneity measures for overall treatment comparisons. This argument is useful in a meta-analysis with subgroups if heterogeneity statistics should only be printed on subgroup level.

test.subgroup

A logical value indicating whether to print results of test for subgroup differences.

test.subgroup.common

A logical value indicating whether to print results of test for subgroup differences (based on common effect model).

test.subgroup.random

A logical value indicating whether to print results of test for subgroup differences (based on random effects model).

prediction.subgroup

A logical indicating whether prediction intervals should be printed for subgroups.

backtransf

A logical indicating whether printed results should be back transformed. If backtransf=TRUE, results for sm="OR" are printed as odds ratios rather than log odds ratios and results for sm="ZCOR" are printed as correlations rather than Fisher's z transformed correlations, for example.

pscale

A numeric giving scaling factor for printing of single event probabilities or risk differences, i.e. if argument sm is equal to "PLOGIT", "PLN", "PRAW", "PAS", "PFT", or "RD".

irscale

A numeric defining a scaling factor for printing of single incidence rates or incidence rate differences, i.e. if argument sm is equal to "IR", "IRLN", "IRS", "IRFT", or "IRD".

irunit

A character specifying the time unit used to calculate rates, e.g. person-years.

subgroup.name

A character string with a name for the grouping variable.

print.subgroup.name

A logical indicating whether the name of the grouping variable should be printed in front of the group labels.

sep.subgroup

A character string defining the separator between label and levels of grouping variable.

nchar.subgroup

A numeric specifying the number of characters to print from subgroup labels.

header

A logical indicating whether information on title of meta-analysis, comparison and outcome should be printed at the beginning of the printout.

print.CMH

A logical indicating whether result of the Cochran-Mantel-Haenszel test for overall effect should be printed.

digits

Minimal number of significant digits, see print.default.

digits.stat

Minimal number of significant digits for z- or t-value of test for overall effect, see print.default.

digits.pval

Minimal number of significant digits for p-value of overall treatment effect, see print.default.

digits.pval.Q

Minimal number of significant digits for p-value of heterogeneity test, see print.default.

digits.Q

Minimal number of significant digits for heterogeneity statistic Q, see print.default.

digits.tau2

Minimal number of significant digits for between-study variance τ^2, see print.default.

digits.tau

Minimal number of significant digits for τ, the square root of the between-study variance τ^2.

digits.H

Minimal number of significant digits for H statistic, see print.default.

digits.I2

Minimal number of significant digits for I-squared and Rb statistic, see print.default.

scientific.pval

A logical specifying whether p-values should be printed in scientific notation, e.g., 1.2345e-01 instead of 0.12345.

big.mark

A character used as thousands separator.

zero.pval

A logical specifying whether p-values should be printed with a leading zero.

JAMA.pval

A logical specifying whether p-values for test of overall effect should be printed according to JAMA reporting standards.

digits.df

Minimal number of significant digits for degrees of freedom.

print.tau2

A logical specifying whether between-study variance τ^2 should be printed.

print.tau

A logical specifying whether τ, the square root of the between-study variance τ^2, should be printed.

print.I2

A logical specifying whether heterogeneity statistic I^2 should be printed.

print.H

A logical specifying whether heterogeneity statistic H should be printed.

print.Rb

A logical specifying whether heterogeneity statistic R_b should be printed.

text.tau2

Text printed to identify between-study variance τ^2.

text.tau

Text printed to identify τ, the square root of the between-study variance τ^2.

text.I2

Text printed to identify heterogeneity statistic I^2.

text.Rb

Text printed to identify heterogeneity statistic R_b.

details.methods

A logical specifying whether details on statistical methods should be printed.

warn.backtransf

A logical indicating whether a warning should be printed if backtransformed proportions and rates are below 0 and backtransformed proportions are above 1.

warn.deprecated

A logical indicating whether warnings should be printed if deprecated arguments are used.

...

Additional arguments (passed on to prmatrix).

bracket

A character with bracket symbol to print lower confidence interval: "[", "(", "{", "".

separator

A character string with information on separator between lower and upper confidence interval.

lower.blank

A logical indicating whether blanks between left bracket and lower confidence limit should be printed.

upper.blank

A logical indicating whether blanks between separator and upper confidence limit should be printed.


meta documentation built on Sept. 18, 2022, 1:06 a.m.