meta (version 8.3-0)

blup.meta: Calculate best linear unbiased predictor for meta object

Description

Calculate best linear unbiased predictors (BLUPs) for meta-analysis object created with R package meta.

Usage

# S3 method for meta
blup(x, level = x$level, backtransf = x$backtransf, ...)
# S3 method for blup.meta
print(
  x,
  backtransf = attr(x, "x")$backtransf,
  digits = gs("digits"),
  digits.se = gs("digits.se"),
  digits.tau2 = gs("digits.tau2"),
  digits.tau = gs("digits.tau"),
  big.mark = gs("big.mark"),
  se = FALSE,
  print.tau2 = gs("print.tau2"),
  print.tau = gs("print.tau"),
  details = gs("details"),
  ...
)
# S3 method for blup.meta
estimates(
  x,
  se = FALSE,
  backtransf = attr(x, "x")$backtransf,
  digits = gs("digits"),
  digits.se = gs("digits.se"),
  digits.tau2 = gs("digits.tau2"),
  digits.tau = gs("digits.tau"),
  writexl = !missing(path),
  path = "estimates_blup.xlsx",
  overwrite = FALSE,
  ...
)
# S3 method for estimates.blup.meta
print(x, big.mark = gs("big.mark"), details = gs("details"), ...)

Value

Data frame with variables

studlab

Study label

blup

estimated best linear unbiased predictor

se.blup

standard error (only if argument backtransf = FALSE)

lower

lower prediction limits

upper

upper prediction limits

Arguments

x

An object of class meta, blup.meta, or estimates.blup.meta.

level

The level used to calculate prediction intervals for BLUPs.

backtransf

A logical indicating whether BLUPs should be back transformed. If backtransf = TRUE, results for sm = "OR" will be odds ratios rather than log odds ratios, for example.

...

Additional arguments (passed on to prmatrix).

digits

Minimal number of significant digits, see print.default.

digits.se

Minimal number of significant digits for standard errors.

digits.tau2

Minimal number of significant digits for between-study variance \(\tau^2\), see print.default.

digits.tau

Minimal number of significant digits for \(\tau\), the square root of the between-study variance \(\tau^2\).

big.mark

A character used as thousands separator.

se

A logical indicating whether standard errors should be printed / extracted.

print.tau2

A logical specifying whether between-study variance \(\tau^2\) should be printed.

print.tau

A logical specifying whether \(\tau\), the square root of the between-study variance \(\tau^2\), should be printed.

details

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

writexl

A logical indicating whether an Excel file should be created (R package writexl must be available).

path

A character string specifying the filename of the Excel file.

overwrite

A logical indicating whether an existing Excel file should be overwritten.

Author

Guido Schwarzer

See Also

metabin

Examples

if (FALSE) {
if (requireNamespace("metadat", quietly = TRUE)) {
data(dat.bcg, package = "metadat")
ma <- metabin(tpos, tpos + tneg, cpos, cpos + cneg,
  data = dat.bcg, studlab = paste(author, year), method = "Inverse")
summary(ma)
blup(ma)

# Save estimates in Excel file (R package 'writexl' must be available)
if (requireNamespace("writexl", quietly = TRUE))
 estimates(blup(ma), path = "blup_ma.xlsx")
}
}