summariseSequenceRatios {CohortSymmetry}

Sequence ratio calculations

Description

Using generateSequenceCohortSet to obtain sequence ratios for the desired outcomes.

Usage

summariseSequenceRatios(
  cohort,
  cohortId = NULL,
  confidenceInterval = 95,
  movingAverageRestriction = 548,
  minCellCount = 5
)

Arguments

cohort

A cohort table in the cdm.

cohortId

The Ids in the cohort that are to be included in the analyses.

confidenceInterval

Default is 95, indicating the central 95% confidence interval.

movingAverageRestriction

The moving window when calculating nSR, default is 548.

minCellCount

The minimum number of events to reported, below which results will be obscured. If 0, all results will be reported.

Value

A local table with all the analyses.

Examples

library(CohortSymmetry)
cdm <- mockCohortSymmetry()
cdm <- generateSequenceCohortSet(cdm = cdm,
                                 name = "joined_cohorts",
                                 indexTable = "cohort_1",
                                 markerTable = "cohort_2")
pssa_result <- summariseSequenceRatios(cohort = cdm$joined_cohorts)
pssa_result
CDMConnector::cdmDisconnect(cdm)