OHDSI / ROhdsiWebApi

An R package for interfacing with a WebAPI instance
https://ohdsi.github.io/ROhdsiWebApi
10 stars 17 forks source link

Gets specification choices that may then be used in R markdown #15

Closed gowthamrao closed 4 years ago

gowthamrao commented 5 years ago

It would be a good function to have if we can get human readable descriptions of a definition in R, ready for use in R-markdown.

The function would apply to cohort Definition, characterization, Incidence rate specification, cohort pathway specification, estimation specification and prediction specification. Note: Cohort generation, concept set and incidence rate - does not currently have design specification #s; while cohort pathways, cohort characterization, estimation and prediction does. We would like to be able to choose between the current saved specification vs. a previously executed design choice.

Returned objects would then be used, thru a separate process, by R-markdown to create a shareable repeatable reports (in html, word, pdf).

Expected content to be returned

  1. Call on cohort definition for returns - separated sections (initial event criteria, restrict intial event criteria, inclusion criteria, cohort exit criteria/end date strategy, cohort eras/collapse strategy) image

  2. Call on characterization - specification choices (cohort definition id, feature analysis choices, sub-group analyses specification, feature analyses parameters, custom feature parameters including description)

  3. Call on cohort pathway - specification choices (target cohort id, event cohort id, analysis settings - combination window, minimum cell count and maximum path length).

  4. Incident rate analysis - specification choices (target cohort id, outcome cohort id, time at risk, study window, stratify criteria). For stratify criteria, in addition to stratify criteria name + description, if we can render the stratification specification that into human readable description - that would be great.

  5. Estimation -

  6. Prediction -