metaumbrella-package {metaumbrella}R Documentation

metaumbrella: An Umbrella Review Package for R

Description

The metaumbrella package offers several facilities to assist in data analysis when performing an umbrella review. This package is built around three core functions which automatically perform the statistical analyses required for an umbrella review (the umbrella() function), stratify the evidence according to various classification criteria (the add.evidence() function) and generate a graphical presentation of the results (the forest() function).

Well-formatted dataset

One of the specificities of the metaumbrella package is that all the functions of this package do not have an argument to specify the name of the variables contained in the dataset of the users. Therefore, it is necessary that the datasets that are passed to the different functions of the package respect a very precise formatting (which we will refer to as well-formatted dataset). We present here the rules that must be respected when creating a well-formatted dataset.

The datasets passed to the functions of the metaumbrella package should contain information on each individual study pooled in the different meta-analyses included in the umbrella review. The information about each individual study must allow for replication of the meta-analyses. It is therefore necessary that the information contained in a well-formatted dataset allows for estimating the effect size and variance of all individual studies. Ten types of effect size measures are accepted:

To estimate the effect size and the variance of each individual study, the metaumbrella package allows for flexible inputs. We detail below (A) the variables that are mandatory and must be indicated in a well-formatted dataset, (B) the variables that vary depending on the effect size measure and (C) the variables that are optional but that can be indicated to benefit from certain features of the package. Note that the package includes examples of well-formatted datasets for each effect size measure (df.SMD, df.SMC, df.R, df.OR, df.RR, df.HR and df.IRR).

A. Mandatory variables

The following variables must be included in the dataset regardless of the effect size measure used. The name of these variables (in bold) cannot be changed.

B. Required information depending on the effect size measure

Depending on the effect size measure used, different information must be provided to replicate the meta-analyses. To allow users adapting to the data available in the original articles, several combinations of information can be provided for a given effect size measure. We detail the information that can provided in the dataset to replicate the meta-analyses and we provide several summary tables displaying the various combinations of minimum information required to replicate the meta-analyses.

We now present the summary tables indicating the minimum combination of information that should be provided for each individual study to run the analyses. The symbol X indicates that the information is provided in a dataset. The symbol + between two information indicates that the two information are mandatory. The symbol | between two information indicates that only one of the two information is required. For each effect size measure, users must provide information on at least one row of the table corresponding to the effect size measure used. Note that users can provide different combination of information for a same factor (e.g., it is possible to include the SMD value + 95% CI + sample sizes for a study and the means/SDs + sample sizes for another study within the same factor).

1. "SMD"
mean_cases + mean_controls +
sd_cases + sd_controls n_cases + n_controls value se | var ci_lo + ci_up
X X - - -
- X X - -
- X X X -
- X X - X
2. "G"
n_cases + n_controls value se | var ci_lo + ci_up
X X - -
X X X -
X X - X
3. "MD"
n_cases + n_controls value se | var ci_lo + ci_up
X X X -
X X - X
4. "SMC"
mean_pre_cases +
mean_pre_controls +
sd_pre_cases +
sd_pre_controls +
mean_cases +
mean_controls +
sd_cases +
sd_controls +
pre_post_cor n_cases + n_controls value se | var ci_lo + ci_up
X X - - -
- X X X -
- X X - X
mean_change_cases +
mean_change_controls +
sd_change_cases +
sd_change_controls n_cases + n_controls
X X
5. "R"
n_sample value se | var ci_lo + ci_up
X X - -
X X X -
X X - X
6. "Z"
n_sample value se | var ci_lo + ci_up
X X - -
X X X -
X X - X
7. "OR" or "logOR"
n_cases_exp +
n_controls_exp +
n_cases_nexp +
n_controls_nexp n_exp + n_nexp n_cases + n_controls value se | var ci_lo + ci_up
X - - - - -
- - X X - -
- - X X X -
- - X X - X
- X - X X -
- X - X - X
8. "RR" or "logRR"
n_cases_exp + n_controls_exp +
n_cases_nexp + n_controls_nexp n_cases + n_controls value se | var ci_lo + ci_up
X - - - -
- X X X -
- X X - X
9. "HR" or "logHR"
n_cases + n_controls value se | var ci_lo + ci_up
X X X -
X X - X
10. "IRR" or "logIRR"
n_cases_exp + n_cases_nexp +
time_exp + time_nexp n_cases time value se | var ci_lo + ci_up
X - - - - -
- X X X X -
- X X X - X

C. Optional variables

The following variables do not have to be included in a well-formatted dataset but they can be added to benefit from certain features of the functions. The name of these variables (in bold) cannot be changed.


[Package metaumbrella version 1.0.11 Index]