documentation:software:heracles
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
documentation:software:heracles [2015/04/09 20:12] jduke |
documentation:software:heracles [2015/04/23 16:36] (current) jduke |
||
|---|---|---|---|
| Line 4: | Line 4: | ||
| **Requirements** | **Requirements** | ||
| - | * Data in OMOP CDM v5 | + | * Data in OMOP CDM v4/v5 |
| - | * [[https://github.com/OHDSI/WebAPI|WebAPI]] installed and running | + | * COHORT and COHORT_DEFINITION tables (or other tables following the OMOP V5 cohort table format) |
| - | * Populated Cohort and Cohort Definition tables (or other tables following the OMOP V5 Cohort table format) | + | |
| + | **Installation** | ||
| + | * Install [[documentation:software:olympus|OLYMPUS]] | ||
| + | * Advanced users may reference [[https://github.com/OHDSI/Heracles/|Heracles on Github]] for custom installation instructions | ||
| **Use** | **Use** | ||
| + | |||
| + | * Select a Cohort from the Heracles dropdown. This will include all cohorts in your cohort definition table. | ||
| {{ :documentation:software:screen_shot_2015-04-09_at_4.04.07_pm.png |}} | {{ :documentation:software:screen_shot_2015-04-09_at_4.04.07_pm.png |}} | ||
| - | - Select a Cohort from the Heracles dropdown. This will include all cohorts in your cohort definition table. | + | * Select analyses individually (as listed below) or as part of a report package (bundle of analyses that will enable Heracles to build a particular visual report of a particular area of interest (e.g., drug exposure)). |
| {{ :documentation:software:screen_shot_2015-04-09_at_3.59.19_pm.png |}} | {{ :documentation:software:screen_shot_2015-04-09_at_3.59.19_pm.png |}} | ||
| - | - Select analyses individually (as listed below) or as part of a report package(bundle of analyses that will enable Heracles to build a particular visual report of a particular area of interest (e.g., drug exposure)). | + | Optional parameters include |
| - | - Optionally select specific concept ID's to run for conditions, drugs, procedures, observations, and measurements (default will run all concept IDs) | + | |
| - | - Optionally set Small Cell Count (minimum number of patients to return for any category) | + | * Specific concept ID's to run for conditions, drugs, procedures, observations, and measurements |
| - | - Optionally Run Heracles Heel for data quality analyses | + | * Small Cell Count (minimum number of patients to return for any category) |
| - | - Optionally limit the analyses to only events occurring within the Cohort Period (as opposed to all events for patients in the cohort) | + | * Run Heracles Heel for data quality analyses |
| + | * Limit the analyses to only events occurring within the Cohort Period (as opposed to all events for patients in the cohort) | ||
| + | |||
| + | * Your analysis will be sent to the Job Manager. If running Olympus, check there for completion status. Or if not in Olympus, use the link provided by Heracles to check it manually. | ||
| + | |||
| + | |||
| + | **Heracles Viewer** | ||
documentation/software/heracles.1428610327.txt.gz · Last modified: 2015/04/09 20:12 by jduke
Page Tools
