umbrella.gui: Graphical User Interface for conducting an umbrella review

View source: R/umbrella_GUI.R

umbrella.guiR Documentation

Graphical User Interface for conducting an umbrella review

Description

The umbrella.gui function allows to perform an umbrella review in R with a graphical user interface and to generate results outside of R.

Usage

umbrella.gui()

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.

To use this function:

  • The first step is to type umbrella.gui() in the console. This will open a pop-up window.

  • The second step is to load a well-formatted dataset (stored in an excel file) by clicking on the button at the right of the "Excel file" label. An exploratory window will open, allowing to select the file that should be uploaded.

  • The third step is to select the folder where the results will be exported. Again, this can be achieved by clicking on the button at the right of the "Output folder" label, and selecting the appropriate folder thanks to the exploratory window.

  • Last, the classification that should be used for stratifying the evidence has to be selected. For now, "Ioannidis" and "GRADE" classifications are available.

Value

The umbrella.gui() 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

if(interactive()){
### open the GUI
umbrella.gui()
}

metaumbrella documentation built on Nov. 7, 2023, 1:06 a.m.