umbrella.xls: Automatically conduct an umbrella review and export results...

Description Usage Arguments Details Value See Also Examples

View source: R/umbrella_XLS.R

Description

The umbrella.xls function allows to automatically perform an umbrella review and to export results outside of R.

Usage

1
2
3
4
5
6
7
8
9
umbrella.xls(
  input_file = NULL,
  sheet = 1,
  output_path = "",
  output_name = "",
  factors_to_analyze = "",
  evidence = NULL,
  plot_results = FALSE
)

Arguments

input_file

path indicating the folder where the dataset (stored in an excel file) is located.

sheet

the number of the excel sheet where the data are located.

output_path

path indicating the folder where the results to be generated.

output_name

name of the files created by the function.

factors_to_analyze

the name(s) of factors to analyze. Can be either a character string indicating the name of the factor to analyze or a vector indicating the names of the factors to analyze. By default, all the factors are analyzed.

evidence

criteria used to stratify evidence. Must be either "Ioannidis" or "GRADE".

plot_results

indicate whether a forest plot of the results is returned. Must be either TRUE or FALSE.

Details

This function implicitly calls the view.errors.umbrella() to check the formatting of the data, the umbrella() function to perform calculations, the add.evidence() function to stratify evidence (limited to "Ioannidis" and "GRADE" classifications for now) and the forest() function to generate a visual representation of the results.

Value

The umbrella.xls() function returns several elements including

csv a csv file containing the results of the umbrella review.
pdf a pdf file containing the plot of the results (only if requested, i.e., the plot_results
argument is set as TRUE).
html an HTML file containing the results of the umbrella review.

See Also

umbrella()
add.evidence()
summary.umbrella()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
if(interactive()){
### perform an umbrella review according to the GRADE criteria.
### the umbrella review is restricted to the factor "Pharmacological"
### Note that the df.SMD should be stored under a .xls or .xlsx format
umbrella.xls(input_file = file.choose(),
             sheet = 1,
             output_path = choose.dir(),
             output_name = "Pharmacological_Ioannidis",
             factors_to_analyze = c("Pharmacological"),
             evidence = "GRADE",
             plot_results = TRUE)
}

metaumbrella documentation built on Jan. 7, 2022, 5:08 p.m.