summariseMeasurementUse {MeasurementDiagnostics} | R Documentation |
Diagnostics of a codelist of measurement codes in the database
Description
Diagnostics of a codelist of measurement codes in the database
Usage
summariseMeasurementUse(
cdm,
codes,
byConcept = TRUE,
byYear = FALSE,
bySex = FALSE,
ageGroup = NULL,
dateRange = as.Date(c(NA, NA)),
checks = c("measurement_timings", "measurement_value_as_numeric",
"measurement_value_as_concept")
)
Arguments
cdm |
A reference to the cdm object. |
codes |
A codelist of measurement/observation codes for which to perform diagnostics. |
byConcept |
TRUE or FALSE. If TRUE code use will be summarised by concept. |
byYear |
TRUE or FALSE. If TRUE code use will be summarised by year. |
bySex |
TRUE or FALSE. If TRUE code use will be summarised by sex. |
ageGroup |
If not NULL, a list of ageGroup vectors of length two. |
dateRange |
Two dates. The first indicating the earliest measurement date and the second indicating the latest possible measurement date. |
checks |
Diagnostics to run. Options are: "measurement_timing", "measurement_value_as_numeric", and "measurement_value_as_concept". |
Value
A summarised result
Examples
library(MeasurementDiagnostics)
cdm <- mockMeasurementDiagnostics()
result <- summariseMeasurementUse(
cdm = cdm, codes = list("test_codelist" = c(3001467L, 45875977L))
)
CDMConnector::cdmDisconnect(cdm = cdm)
[Package MeasurementDiagnostics version 0.0.1 Index]