meta (version 9.0-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,
  print = NULL,
  digits = NULL,
  big.mark = gs("big.mark"),
  se = FALSE,
  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,
  digits = NULL,
  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).

print

A named list controlling displayed information in print.blup.meta; see meta-formatting. Elements tau2 and tau select heterogeneity columns.

digits

A named list controlling rounding in print methods; see meta-formatting. A scalar rounds effects and limits. For estimates.blup.meta, a scalar giving the minimal number of significant digits.

big.mark

A character used as thousands separator.

se

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

details

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

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

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 [email protected]

Details

The print methods accept a named digits list with elements digits, se, tau2, and tau; see meta-formatting. A scalar rounds effects and limits only. The BLUP printer uses gs("digits") for effect rounding and gs("print.tau2") and gs("print.tau") for heterogeneity columns. The estimates printer defaults to rounding stored in the object and does not back-transform again. Extraction with estimates.blup.meta still uses scalar rounding arguments.

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")
}
}