This is an R package that implements a library of standard queries that run against the OMOP-CDM. The purpose of the library is to help new users to learn how to query the CDM. The queries in the library have been approved by the OHDSI community. The query library will be mainly used for training purposes, but will also be a valuable resource for the experienced users.
- Automatically renders the queries to the dialect, cdm and vocabulary schemas as specified by the user
- Can execute the query against a user's database
- Allows saving and loading user settings
QueryLibrary is an R package that uses Shiny and Markdown. The tool automatically reads and renders sql from Markdown files in its queries folder. The query file contains a description of the query, and explains the input variables and results table. The following information is parsed from the markdown files using tags:
- Group. Allows to group queries, e.g. by domain
- Name. The name of the query in the search table.
- CDM-Version. The version this query runs on, e.g. >5.0
- Author. The person responsible for writing the query
- Query. The query is taken from the .Md file, rendered using SqlRender and is shown to the user in its preferred dialect.
The execution functionality has been made optional, so this can be switched off when installed on a public server. This can be done in the global.R with the following parameter: allow_execute = FALSE
Running the package requires R with the package rJava installed. Also requires Java 1.6 or higher.
- SQLRender
- DatabaseConnector
- Shiny
The easiest way to use the QueryLibrary is by using the public OHDSI QueryLibrary.
To install the latest development version, install from GitHub:
install.packages("devtools")
devtools::install_github("ohdsi/QueryLibrary")Once installed, you can try out the Shiny app that comes with the package:
library(QueryLibrary)
launchQueryLibrary()The configuration section allows the user to set the dialect and other connectionDetails for the CDM. This settings file can be saved and loaded using the buttons on the top of the page.
Using the library table the user can select a query. The markdown file of the query can be see on the right. The Execute tab allows the user to import the selected query, edit the query (the window can be made bigger if needed), run, copy, and save the query. The tool will show a counter when the query is runninng and will show the results table below the query.
We would like to increase the number of queries in the library and like the community to drive this. If there are suggestions please post them in the issue tracker or even better do a pull request and we will review and approve your query.
Note that if you add queries you have to follow the OHDSI code style for SQL.
- Vignette: Using QueryLibrary
- Package manual: QueryLibrary manual
- Developer questions/comments/feedback: OHDSI Forum
- We use the GitHub issue tracker for all bugs/issues/enhancements
QueryLibrary is licensed under Apache License 2.0
QueryLibrary is being developed in R Studio.
Beta testing.
This work was performed within the European Health Data & Evidence Network (EHDEN) project in collaboration with OHDSI. The European Health Data & Evidence Network has received funding from the Innovative Medicines Initiative 2 Joint Undertaking (JU) under grant agreement No 806968. The JU receives support from the European Union’s Horizon 2020 research and innovation programme and EFPIA.