README.md

In redcdm/REDCOHORT_US: A Study Package for Generating Cohort Diagnostics

REDCOHORT

• Analytics use case(s): Characterization
• Study type: Methods Research
• Tags: REDCDM
• Study lead: REDCDM
• Study lead forums tag: -
• Study start date: Jan 1, 2019
• Study end date: -
• Protocol: -
• Publications: 0
• Results explorer: Shiny app

Requirements

• A database in Common Data Model version 5 in one of these platforms: SQL Server, Oracle, PostgreSQL, IBM Netezza, Apache Impala, Amazon RedShift, Google BigQuery, or Microsoft APS.
• R version 4.0.0 or newer
• On Windows: RTools
• Java
• 25 GB of free disk space

How to run

1. Follow these instructions for setting up your R environment, including RTools and Java.

2. Open your study package in RStudio. Use the following code to install all the dependencies:

   r renv::restore()

3. In RStudio, select 'Build' then 'Install and Restart' to build the package.

4. Once installed, you can execute the study by modifying and using the code below. For your convenience, this code is also provided under extras/CodeToRun.R:

   ```r library(redCohort)

   Maximum number of cores to be used:

   maxCores <- parallel::detectCores()

   The folder where the study intermediate and result files will be written:

   outputFolder <- "c:/redCohort"

   Details for connecting to the server:

   See ?DatabaseConnector::createConnectionDetails for help

   connectionDetails <- DatabaseConnector::createConnectionDetails(dbms = "postgresql", server = "some.server.com/ohdsi", user = "joe", password = "secret")

   The name of the database schema where the CDM data can be found:

   cdmDatabaseSchema <- "cdm_synpuf"

   The name of the database schema and table where the study-specific cohorts will be instantiated:

   cohortDatabaseSchema <- "scratch.dbo" cohortTable <- "my_study_cohorts"

   Some meta-information that will be used by the export function:

   databaseId <- "Synpuf" databaseName <- "Medicare Claims Synthetic Public Use Files (SynPUFs)" databaseDescription <- "Medicare Claims Synthetic Public Use Files (SynPUFs) were created to allow interested parties to gain familiarity using Medicare claims data while protecting beneficiary privacy. These files are intended to promote development of software and applications that utilize files in this format, train researchers on the use and complexities of Centers for Medicare and Medicaid Services (CMS) claims, and support safe data mining innovations. The SynPUFs were created by combining randomized information from multiple unique beneficiaries and changing variable values. This randomization and combining of beneficiary information ensures privacy of health information."

   For Oracle: define a schema that can be used to emulate temp tables:

   oracleTempSchema <- NULL

   runCohortDiagnostics(connectionDetails = connectionDetails, cdmDatabaseSchema = cdmDatabaseSchema, cohortDatabaseSchema = cohortDatabaseSchema, cohortTable = cohortTable, oracleTempSchema = oracleTempSchema, outputFolder = outputFolder, databaseId = databaseId, databaseName = databaseName, databaseDescription = databaseDescription, createCohorts = TRUE, synthesizePositiveControls = TRUE, runAnalyses = TRUE, packageResults = TRUE, maxCores = maxCores) ```

5. Upload the file export/Results_<DatabaseId>.zip in the output folder to the study coordinator:

   r uploadResults(outputFolder, privateKeyFileName = "<file>", userName = "<name>")

   Where <file> and <name< are the credentials provided to you personally by the study coordinator.

6. To view the results, use the Shiny app:

   r launchDiagnosticsExplorer()

Note that you can save plots from within the Shiny app.

License

The redCohort package is licensed under Apache License 2.0

Development

redCohort was developed in ATLAS and R Studio.

Development status

Unknown

redcdm/REDCOHORT_US documentation built on Dec. 31, 2021, 12:06 a.m.