Introduction
This repository describes the OHDSI HADES results model. These are the tables that are populated by the various HADES packages, often as part of a Strategus execution. The repository also contains an R package with model resources and utilities.
Here you’ll find:
- Versioned YAML definitions of tables and their fields (per HADES package)
- JSON Schemas for YAML validation
- Release manifests for HADES-wide versions
- A human-readable overview of the latest released version
This repository follows the standard R package structure. Model resources live under inst/:
-
inst/modules/: versioned module definitions (<ModuleName>/v<semver>/definition.yaml) -
inst/releases/: release manifests (release_vYYYY_QX.yaml) -
inst/schemas/: JSON Schemas used for validation -
inst/sql/: generated holistic SQL output (working/output directory)
Example: Migrating a results database to the latest version
library(HadesResultsModel)
connection <- DatabaseConnector::connect(dbms = "postgresql", ...)
# Detect current data model versions in your database
versions <- inferCurrentVersions(connection)
# Migrate database to latest versions
migrateResultsModel(connection, targetVersions = NULL) # NULL = latestInstallation
See the instructions here for configuring your R environment, including RTools and Java.
-
In R, use the following commands to download and install HadesResultsModel:
install.packages("remotes") remotes::install_github("ohdsi/HadesResultsModel")
User Documentation
Documentation can be found on the package website.
PDF versions of the documentation are also available:
- Vignette: Single studies using the HadesResultsModel package
- Package manual: HadesResultsModel.pdf
Support
- Developer questions/comments/feedback: OHDSI Forum
- We use the GitHub issue tracker for all bugs/issues/enhancements
Contributing
Read here how you can contribute to this package.