ReportGenerator

Overview

ReportGenerator creates automatic study reports from DARWIN EU® research. It is a Shiny app with an interactive menu where the user can select figures and tables from the Complete Catalogue of Standard Data Analyses.

Installation

You can install the development version of ReportGenerator like so:

install.packages("remotes")
remotes::install_github("darwin-eu-dev/ReportGenerator")

reportGenerator() takes as an input zip or csv files with results from IncidencePrevalence. To launch the Shiny app just type in the console:

ReportGenerator::reportGenerator()

Alternatively, you can access to an online version here.

Load your own results from the IncidencePrevalence or TreatmentPatterns packages. ReportGenerator accepts data from the latest versions, but offers limited legacy support.

ReportGenerator() accepts files in ZIP format from multiple data partners, with the following directory structure, or CSV files to visualise individual results.

# IncidencePrevalence ZIP Folders

  C:
  |--results_CHUBX.zip
  |       |--incidence_attrition.csv
  |       |--prevalence_attrition.csv
  |       |--incidence_estimates.csv
  |       |--prevalence_estimates.csv
  |
  |--results_CPRD.zip
  |--results_IMASIS.zip
  |--results_IPCI.zip

# CSV files

  C:
  |
  |--incidence_attrition.csv
  |--prevalence_attrition.csv
  |--incidence_estimates.csv
  |--prevalence_estimates.csv

In the same way, the user can load results from TreatmentPatterns in ZIP format, including the metadata file to identify results from each data partner.

# Directory TreatmentPatterns

  C:
  |--results_CPRD.zip
  |       |--countsAge.csv
  |       |--countsSex.csv
  |       |--metadata.csv
  |       |--summaryStatsTherapyDuraion.csv
  |       |--treatmentPathways.csv
  |
  |--results_IMASIS.zip
  |--results_IPCI.zip
  |--results_SIDIAP.zip

To test the package, the user can generate some mock data with ReportGenerator::generateMockData(), which will create a “Results” folder with data in zip format.

ReportGenerator::generateMockData()