Skip to contents

A function to extract cohort aggregate binary feature characterization results

Source: R/CharacterzationQueries.R
getCharacterizationCohortBinary.Rd

A function to extract cohort aggregate binary feature characterization results

Usage

getCharacterizationCohortBinary(
  connectionHandler,
  schema,
  cTablePrefix = "c_",
  cgTablePrefix = "cg_",
  databaseTable = "database_meta_data",
  targetIds = NULL,
  databaseIds = NULL,
  minThreshold = 0
)

Arguments

connectionHandler

A connection handler that connects to the database and extracts sql queries. Create a connection handler via `ResultModelManager::ConnectionHandler$new()`.

schema

The result database schema (e.g., 'main' for sqlite)

cTablePrefix

The prefix used for the characterization results tables

cgTablePrefix

The prefix used for the cohort generator results tables

databaseTable

The name of the table with the database details (default 'database_meta_data')

targetIds

A vector of integers corresponding to the target cohort IDs

databaseIds

(optional) One or more unique identifiers for the databases

minThreshold

The minimum fraction of the cohort that must have the feature for it to be reported

Value

A data.frame with the characterization aggregate binary features for a specific cohort and database

Details

Specify the connectionHandler, the schema and the target cohort ID and database id

See also

Other Characterization: getBinaryCaseSeries(), getBinaryRiskFactors(), getCaseBinaryFeatures(), getCaseContinuousFeatures(), getCaseCounts(), getCaseTargetBinaryFeatures(), getCaseTargetCounts(), getCharacterizationCohortContinuous(), getCharacterizationDemographics(), getCharacterizationOutcomes(), getCharacterizationTargets(), getContinuousCaseSeries(), getContinuousRiskFactors(), getDechallengeRechallenge(), getDechallengeRechallengeFails(), getIncidenceOutcomes(), getIncidenceRates(), getIncidenceTargets(), getTargetBinaryFeatures(), getTargetContinuousFeatures(), getTimeToEvent(), plotAgeDistributions(), plotSexDistributions()

Examples

conDet <- getExampleConnectionDetails()

connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)
#> Connecting using SQLite driver

binCohort <- getCharacterizationCohortBinary(
  connectionHandler = connectionHandler, 
  schema = 'main',
  targetIds = 1, 
  databaseIds = 'eunomia'
)