Skip to contents

Format a measurement_summary object into a visual table

Usage

tableMeasurementValueAsNumber(
  result,
  header = c(visOmopResults::strataColumns(result)),
  groupColumn = c("codelist_name"),
  settingsColumn = character(),
  hide = c("variable_name", "variable_level"),
  style = NULL,
  type = NULL,
  .options = list()
)

Arguments

result

A summarised_result object.

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), or NULL which converts to "default" style, or custom code.

type

Type of table. Check supported types with `visOmopResults::tableType()`. If NULL 'gt' type will be used.

.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))
)
#> → Sampling measurement table to 20000 subjects
#> → Getting measurement records based on 2 concepts.
#> → Subsetting records to the subjects and timing of interest.
#> → Getting time between records per person.
#> Summarising timings
#>  The following estimates will be calculated:
#>  days_between_measurements: min, q25, median, q75, max, density
#> ! Table is collected to memory as not all requested estimates are supported on
#>   the database side
#> → Start summary of data, at 2026-02-09 16:11:24.79697
#>  Summary finished, at 2026-02-09 16:11:24.918198
#> → Getting measurements per subject.
#>  The following estimates will be calculated:
#>  measurements_per_subject: min, q25, median, q75, max, density
#> ! Table is collected to memory as not all requested estimates are supported on
#>   the database side
#> → Start summary of data, at 2026-02-09 16:11:25.458812
#>  Summary finished, at 2026-02-09 16:11:25.547004
#> → Summarising results - value as number.
#> Summarising value as number
#>  The following estimates will be calculated:
#>  value_as_number: min, q01, q05, q25, median, q75, q95, q99, max,
#>   count_missing, percentage_missing, density
#> ! Table is collected to memory as not all requested estimates are supported on
#>   the database side
#> → Start summary of data, at 2026-02-09 16:11:27.150754
#>  Summary finished, at 2026-02-09 16:11:27.428986
#> → Summarising results - value as concept.
#> Summarising value as number
#>  The following estimates will be calculated:
#>  value_as_concept_id: count, percentage
#> → Start summary of data, at 2026-02-09 16:11:28.11765
#>  Summary finished, at 2026-02-09 16:11:28.253433
#> → Binding all diagnostic results.

tableMeasurementValueAsNumber(result)
CDM name Concept name Concept ID Source concept name Source concept ID Domain ID Unit concept name Unit concept ID Estimate name Estimate value
test_codelist
mock database overall overall overall overall overall kilogram 9529 N 50
Median [Q25 – Q75] 8.77 [7.07 – 10.48]
Q05 – Q95 5.70 – 11.84
Q01 – Q99 5.43 – 12.11
Range 5.36 to 12.18
Missing value, N (%) 2 (4.00%)
NA - N 50
Median [Q25 – Q75] 8.77 [7.10 – 10.44]
Q05 – Q95 5.77 – 11.77
Q01 – Q99 5.50 – 12.04
Range 5.44 to 12.11
Missing value, N (%) 3 (6.00%)
Alkaline phosphatase.bone [Enzymatic activity/volume] in Serum or Plasma 3001467 NA - Measurement kilogram 9529 N 50
Median [Q25 – Q75] 8.77 [7.07 – 10.48]
Q05 – Q95 5.70 – 11.84
Q01 – Q99 5.43 – 12.11
Range 5.36 to 12.18
Missing value, N (%) 2 (4.00%)
NA - N 50
Median [Q25 – Q75] 8.77 [7.10 – 10.44]
Q05 – Q95 5.77 – 11.77
Q01 – Q99 5.50 – 12.04
Range 5.44 to 12.11
Missing value, N (%) 3 (6.00%)
CDMConnector::cdmDisconnect(cdm = cdm) # }