StudyRepoTemplate
An OHDSI study repository is expected to have a README.md file where the header conforms to a standard. A template README file is provided here:
When initiating a repository, please copy this file, rename it to 'README.md', and fill in the fields as appropriate.
The information in the repository README file will be used to automatically update the list of OHDSI research studies, so it is important to fill in the template accurately, and keep it up-to-date.
Elements in the README template
| Element | Description |
|---|---|
| [Study title] | A meaningful title of the research project. |
| Study status badge | A badge indicating the study status. See below for valid options. |
| Analytics use case | One or more analytics use cases included in the study (in a comma-separated list). See below for valid options. |
| Study type | The type of study. See below for valid options. |
| Tags | Zero, one, or more additional keywords that can be used to filter the list of studies. The list of tags is not restricted, but be conservative in making up new tags. For example: EHDEN to identify studies that are part of the EHDEN project. |
| Study lead | The name of the study lead. |
| Study lead forums tag | The OHDSI forums tag of the study lead, which can be used to contact the lead. It is recommended to make this a hyperlink to lead's forums profile |
| Study start date | When did work on the study commence? This date typically indicates when development of the protocol was initiated. Format: [Month] [Day], [Year] (e.g. May 1, 2019) |
| Study end date | When was the study completed? This typically indicates when the analyses were completed and the results have been collected. Do not enter future (planned) dates here. Format: [Month] [Day], [Year] (e.g. May 1, 2019) |
| Protocol | A hyperlink to the protocol. The protocol is expected to be a document in the study repository itself. |
| Publications | Zero, one or more hyperlinks to papers produced as part of the study (comma-separated). |
| Results explorer | A hyperlink to a web app (e.g. a Shiny app) where the results of the study can be explored. |
Study Status
Choose one of the following options:
| Badge | Description |
|---|---|
 |
The study repository has just been created. Work has not yet commenced. |
 |
A first commit was made (to something else than the README file). Work has commenced. |
 |
The protocol and study code have been finalized. |
 |
The study results are publicly available, for example in a paper or results explorer app. |
 |
The study is complete, no further dissemination planned. |
 |
The study has been suspended, and may or may not be continued at a later point in time. |
Copy the relevant markdown code from this page, and paste it in your README file, just below the study title.
Analytics Use Cases
Choose one or more options from:
CharacterizationPopulation-Level Estimation, orPatient-Level Prediction
See the Data Analytics Use Cases chapter for more details.
Study types
Can be either:
Methods Researchif the study explores a methodological question, for example an evaluation of various propensity score approaches.Clinical Applicationif the study aims to answer a clinically relevant question, for example 'Does drug A cause outcome B?'.