/PhenotypeLibrary

A repository to store, organize and maintain the content of the OHDSI Phenotype library.

Primary LanguageROtherNOASSERTION

PhenotypeLibrary

Build Status codecov.io

PhenotypeLibrary is part of HADES.

Introduction

PhenotypeLibrary is a repository to store the content of the OHDSI Phenotype Library (Library). These phenotype/cohort definitions have under gone an OHDSI best practice Phenotype Development and Evaluation Process by the OHDSI Phenotype Development and Evaluation Work group (work group). This Work group, through a OHDSI community wide collaboration effort, evaluates and maintains cohort definitions in an Atlas instance. Definitions that have graduated through this process are published in this repository, and are thus considered high quality cohort definitions.

cohortId's in this repository are persistent (similar to OMOP Concept Id) i.e. once published it maybe expected to stay the same between releases of the Phenotype library (i.e. backward compatible). Version numbers in this repository follows HADES convention, and changes (addition or deletions) are reported as News. Work group will be responsible to maintain a cadence for the cohort life cycle - including deprecation and additions.

Features

  • Contains all phenotypes (i.e. cohort definitions) that have been approved by the OHDSI Phenotype Development and Evaluation workgroup.
  • Phenotypes are available as SQL statements and JSON.
  • Can provide cohortDefinitionSet object that maybe directly used as input by other OHDSI R packages like OHDSI CohortGenerator and CohortDiagnostics. See accompanying vignettes.

Technology

PhenotypeLibrary is an R package.

System Requirements

Requires R (version 3.6.0 or higher).

Installation

  1. See HADES instructions for configuring your R environment, including RTools and Java.

  2. In R, use the following commands to download and install PhenotypeLibrary:

install.packages("remotes")
remotes::install_github("ohdsi/PhenotypeLibrary")

User Documentation

Documentation can be found on the package website.

PDF versions of the documentation are also available:

Support

Contributing

Read HADES contribution how you can contribute to thee software in this package. To contribute to the Cohort Definitions, Phenotype Development and Evaluation - please visit the Microsoft Teams website of the OHDSI Phenotype Development and Evaluation Work group.

License

PhenotypeLibrary is licensed under Apache License 2.0

Development

PhenotypeLibrary is being developed in R Studio.

Development status

PhenotypeLibrary is under development.