Skip to contents

Format a measurement_timings object into a visual table

tableMeasurementTimings.Rd

Format a measurement_timings object into a visual table

Usage

tableMeasurementTimings(
  result,
  type = "gt",
  header = c(visOmopResults::strataColumns(result)),
  groupColumn = c("codelist_name"),
  settingsColumn = character(),
  hide = c("variable_level"),
  style = "default",
  .options = list()
)

Arguments

result

A summarised_result object.

type

Type of table. Check supported types with `visOmopResults::tableType()`.

header

Columns to use as header. See options with `visOmopResults::tableColumns(result)`.

groupColumn

Columns to group by. See options with `visOmopResults::tableColumns(result)`.

settingsColumn

Columns from settings to include in results. See options with `visOmopResults::settingsColumns(result)`.

hide

Columns to hide from the visualisation. See options with `visOmopResults::tableColumns(result)`.

style

Named list that specifies how to style the different parts of the table generated. It can either be a pre-defined style ("default" or "darwin" - the latter just for gt and flextable), NULL to get the table type default style, or custom. Keep in mind that styling code is different for all table styles. To see the different styles use visOmopResults::tableStyle().

.options

A named list with additional formatting options. `visOmopResults::tableOptions()` shows allowed arguments and their default values.

Value

A formatted table

Examples

# \donttest{
library(MeasurementDiagnostics)
cdm <- mockMeasurementDiagnostics()
result <- summariseMeasurementUse(
              cdm = cdm,
              codes = list("test_codelist" = c(3001467L, 45875977L)))
#> → Getting measurement records based on 2 concepts.
#> → Subsetting records to the subjects and timing of interest.
#> → Getting time between records per person.
#> → Summarising results - value as number.
#> → Summarising results - value as concept.
#> → Binding all diagnostic results.
tableMeasurementTimings(result)



  
CDM name
      Variable name
      Estimate name
      Estimate value
    
test_codelist
    
mock database
Number records
N
100

Number subjects
N
67

Time (days)
Median [Q25 - Q75]
249.00 [67.00 - 645.00]


Range
8.00 to 2,886.00

Measurements per subject
Median [Q25 - Q75]
2.00 [1.00 - 2.00]


Range
1.00 to 4.00
CDMConnector::cdmDisconnect(cdm = cdm)
# }