Package overview

Overview of the SelfControlledCohort package

SelfControlledCohort SelfControlledCohort-package

SelfControlledCohort: Population-Level Estimation Method That Estimates Incidence Rate Comparison of Exposed/Unexposed Time Within an Exposed Cohort

Running a Single Study

Functions for executing a Self-Controlled Cohort study

runSelfControlledCohort()

Run self-controlled cohort

createRunSelfControlledCohortArgs()

Create a parameter object for the function runSelfControlledCohort

Running Multiple Analyses

Functions for running multiple analyses across many exposure-outcome pairs

runSccAnalyses()

Run a list of analyses

createSccAnalysis()

Create a SelfControlledCohort analysis specification

createExposureOutcome()

Create exposure-outcome combinations.

saveSccAnalysisList()

Save a list of sccAnalysis to file

loadSccAnalysisList()

Load a list of sccAnalysis from file

saveExposureOutcomeList()

Save a list of exposureOutcome to file

loadExposureOutcomeList()

Load a list of exposureOutcome from file

Diagnostics

Functions for evaluating SCC study diagnostics

runSccDiagnostics()

Run Self-Controlled Cohort Diagnostics

getDefaultDiagnosticThresholds()

Get default diagnostic thresholds

getDiagnosticsSummary()

Get diagnostics summary

computeMdrrForRateRatio()

Compute Minimum Detectable Relative Risk (MDRR) for rate ratio

computeEase()

Compute Expected Absolute Systematic Error (EASE)

Risk Windows

Functions related to computing and evaluating risk windows

runSccRiskWindows()

Run Self-Controlled Cohort Risk Windows

getSccRiskWindowStats()

Get Self-Controlled Cohort Risk Window Statistics

Results Data Model

Functions for managing and uploading study results

createResultsDataModel()

Create the results data model tables on a database server.

uploadResults()

Upload results to the database server.

getResultsDataModelSpecifications()

Get specifications for CohortMethod results data model

migrateDataModel()

Migrate Data model

getDataMigrator()

Get database migrations instance

getDefaultExportManager()

Get Default export manager

getResultsFolders()

Get results folders for an analysis specification

Strategus Module

Functions for integrating with the Strategus execution framework

createSelfControlledCohortModuleSpecifications()

Create Self-Controlled Cohort Module Specifications

checkModuleVersion()

Check module version compatibility

execute()

Execute Self-Controlled Cohort Analyses for Strategus

getModuleInfo()

Get module information