Introduction

In this vignette we will explore the functionality and arguments of a set of functions that will help us to understand and visualise the temporal symmetry results (produced Step 4: Obtain aggregated data on temporal symmetry). In particular, we will delve into the following function:

• plotTemporalSymmetry(): to plot the temporal symmetry.

This function builds-up on previous functions, such as generateSequenceCohortSet() and summariseTemporalSymmetry() function.

Let’s regather the output from summariseTemporalSymmetry()

temporal_symmetry <- summariseTemporalSymmetry(cohort = cdm$intersect)

With this established, much like summariseSequenceRatios(), the object temporal_symmetry could then be fed into tableTemporalSymmetry() or plotTemporalSymmetry() to visualise the results:

tableTemporalSymmetry(result = temporal_symmetry)

plotTemporalSymmetry(result = temporal_symmetry)

Note that the x axis is the time, which we recall to be the initiation of the marker minus the initiation of the index. The unit of the time difference here is month as this is the default from summarisTemporalSymmetry().

CDMConnector::cdmDisconnect(cdm = cdm)

That would be the end of the vignette, have fun with the package!