summariseMeasurementDoc

Helper for consistent documentation of `summariseMeasurement` functions.

internal

Diagnostics of list of codes based on concepts from the domains measurement and observation. This package works for data mapped to the Observational Medical Outcomes Partnership Common Data Model.

Nuria Mercade-Besora

MeasurementDiagnostics

Diagnostics for Lists of Codes Based on Measurements

Edward Burn

Marta Alcalde-Herraiz

summariseMeasurementDoc function

<dl><dt>cdm</dt>
<dd>A reference to the cdm object.</dd>
<dt>codes</dt>
<dd>A codelist of measurement/observation codes for which to perform
diagnostics.</dd>
<dt>cohort</dt>
<dd>A cohort in which to perform the diagnostics of the measurement
codes provided.</dd>
<dt>timing</dt>
<dd>Three options: 1) "any" if the interest is on measurement
recorded any time, 2) "during", if interested in measurements while the
subject is in the cohort (or in observation if cohort = NULL), and 3)
"cohort_start_date" for measurements occurring at cohort start date (or at
"observation_period_start_date if cohort = NULL).</dd>
<dt>byConcept</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by concept.</dd>
<dt>byYear</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by year.</dd>
<dt>bySex</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by sex.</dd>
<dt>ageGroup</dt>
<dd>If not NULL, a list of ageGroup vectors of length two.</dd>
<dt>dateRange</dt>
<dd>Two dates. The first indicating the earliest measurement
date and the second indicating the latest possible measurement date.</dd>
<dt>checks</dt>
<dd>Diagnostics to run. Options are: "measurement_timing",
"measurement_value_as_numeric", and "measurement_value_as_concept".</dd></dl>

Arguments

Helper for consistent documentation of `summariseMeasurement` functions. — summariseMeasurementDoc

<dl>

<dt>cdm</dt>
<dd>A reference to the cdm object.</dd>


<dt>codes</dt>
<dd>A codelist of measurement/observation codes for which to perform
diagnostics.</dd>


<dt>cohort</dt>
<dd>A cohort in which to perform the diagnostics of the measurement
codes provided.</dd>


<dt>timing</dt>
<dd>Three options: 1) "any" if the interest is on measurement
recorded any time, 2) "during", if interested in measurements while the
subject is in the cohort (or in observation if cohort = NULL), and 3)
"cohort_start_date" for measurements occurring at cohort start date (or at
"observation_period_start_date if cohort = NULL).</dd>


<dt>byConcept</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by concept.</dd>


<dt>byYear</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by year.</dd>


<dt>bySex</dt>
<dd>TRUE or FALSE. If TRUE code use will be summarised by sex.</dd>


<dt>ageGroup</dt>
<dd>If not NULL, a list of ageGroup vectors of length two.</dd>


<dt>dateRange</dt>
<dd>Two dates. The first indicating the earliest measurement
date and the second indicating the latest possible measurement date.</dd>


<dt>checks</dt>
<dd>Diagnostics to run. Options are: "measurement_timing",
"measurement_value_as_numeric", and "measurement_value_as_concept".</dd>

</dl>

summariseMeasurementDoc: Helper for consistent documentation of `summariseMeasurement` functions.

Description

Arguments