getDechallengeRechallengeFails: A function to extract the failed dechallenge-rechallenge...

View source: R/CharacterzationQueries.R

getDechallengeRechallengeFailsR Documentation

A function to extract the failed dechallenge-rechallenge cases

Description

A function to extract the failed dechallenge-rechallenge cases

Usage

getDechallengeRechallengeFails(
  connectionHandler,
  schema,
  cTablePrefix = "c_",
  characterizationTargetId = NULL,
  outcomeId = NULL,
  databaseId = NULL,
  dechallengeStopInterval = NULL,
  dechallengeEvaluationWindow = NULL
)

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

characterizationTargetId

The characterization target cohort id of interest

outcomeId

Am integer corresponding to the outcome cohort ID

databaseId

The unique identifier for the database of interest

dechallengeStopInterval

(optional) The maximum number of days between the outcome start and target end for an outcome to be flagged

dechallengeEvaluationWindow

(optional) The maximum number of days after the target restarts to see whether the outcome restarts

Details

Specify the connectionHandler, the schema and the target/outcome cohort IDs and database id

Value

A data.frame each failed dechallenge rechallenge exposures and outcomes

See Also

Other Characterization: characterizationCompareBinary(), characterizationCompareContinuous(), getAggregateBinaryRiskFactors(), getAggregateContinuousRiskFactors(), getBinaryCaseSeries(), getBinaryRiskFactors(), getBinaryTargetBaseline(), getCaseCounts(), getCharacterizationCaseSettings(), getCharacterizationDemographics(), getCharacterizationTargetSettings(), getContinuousCaseSeries(), getContinuousRiskFactors(), getContinuousTargetBaseline(), getDechallengeRechallenge(), getIncidenceRates(), getIncidenceTargetSettings(), getNonCaseCounts(), getOutcomesUsedInCharacterization(), getOutcomesUsedInIncidence(), getTargetCounts(), getTargetsUsedInCharacterization(), getTargetsUsedInIncidence(), getTimeToEvent(), plotAgeDistributions(), plotSexDistributions(), viewIncidenceRate()

Examples

conDet <- getExampleConnectionDetails()

connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)

conCohort <- getDechallengeRechallengeFails(
  connectionHandler = connectionHandler, 
  schema = 'main',
  characterizationTargetId = 1, 
  outcomeId = 3,
  databaseId = 'eunomia'
)


OhdsiReportGenerator documentation built on Nov. 14, 2026, 1:09 a.m.