Skip to contents

A function to extarct the targets found in characterization

Source: R/CharacterzationQueries.R
getCharacterizationTargets.Rd

A function to extarct the targets found in characterization

Usage

getCharacterizationTargets(
  connectionHandler,
  schema,
  cTablePrefix = "c_",
  cgTablePrefix = "cg_",
  printTimes = FALSE,
  useTte = TRUE,
  useDcrc = TRUE,
  useRf = TRUE
)

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

printTimes

Print the time it takes to run each query

useTte

whether to determine what cohorts are used in time to event

useDcrc

whether to determine what cohorts are used in dechal-rechal

useRf

whether to determine what cohorts are used in risk factor

Value

A data.frame with the characterization target cohort ids, names and which characterization analyses the cohorts are used in.

Details

Specify the connectionHandler, the schema and the prefixes

See also

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

Examples

conDet <- getExampleConnectionDetails()

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

cohorts <- getCharacterizationTargets(
  connectionHandler = connectionHandler, 
  schema = 'main'
)
#> [1] "-- all extracting characterization targets took: 0.0975894927978516 secs"