summariseInObservation

Summarises key information in data mapped to the Observational
Medical Outcomes Partnership (OMOP) common data model. Assess suitability to
perform specific epidemiological studies and explore the different domains
to obtain feasibility counts and trends.

Cecilia Campanile

OmopSketch

Characterise Tables of an OMOP Common Data Model Instance

Marta Alcalde-Herraiz

Kim Lopez-Guell

Elin Rowlands

Edward Burn

Martí Català

summariseInObservation function

<dl><dt>observationPeriod</dt>
<dd>An observation_period omop table. It must be part of
a cdm_reference object.</dd>
<dt>interval</dt>
<dd>Time interval to stratify by. It can either be "years",
"quarters", "months" or "overall".</dd>
<dt>output</dt>
<dd>Output format. It can be either the number of records
("record") that are in observation in the specific interval of time, the
number of person-days ("person-days"), the number of subjects ("person"),
the number of females ("sex") or the median age of population in observation
("age").</dd>
<dt>ageGroup</dt>
<dd>A list of age groups to stratify the results by. Each element
represents a specific age range. You can give them specific names, e.g.
<code>ageGroup = list(children = c(0, 17), adult = c(18, Inf))</code>.</dd>
<dt>sex</dt>
<dd>Logical; whether to stratify results by sex (<code>TRUE</code>) or not
(<code>FALSE</code>).</dd>
<dt>dateRange</dt>
<dd>A vector of two dates defining the desired study period.
Only the <code>start_date</code> column of the OMOP table is checked to ensure it falls within this range.
If <code>dateRange</code> is <code>NULL</code>, no restriction is applied.</dd></dl>

Arguments

Summarise the number of people in observation during a specific interval of
time — summariseInObservation

<dl>

<dt>observationPeriod</dt>
<dd>An observation_period omop table. It must be part of
a cdm_reference object.</dd>


<dt>interval</dt>
<dd>Time interval to stratify by. It can either be "years",
"quarters", "months" or "overall".</dd>


<dt>output</dt>
<dd>Output format. It can be either the number of records
("record") that are in observation in the specific interval of time, the
number of person-days ("person-days"), the number of subjects ("person"),
the number of females ("sex") or the median age of population in observation
("age").</dd>


<dt>ageGroup</dt>
<dd>A list of age groups to stratify the results by. Each element
represents a specific age range. You can give them specific names, e.g.
<code>ageGroup = list(children = c(0, 17), adult = c(18, Inf))</code>.</dd>


<dt>sex</dt>
<dd>Logical; whether to stratify results by sex (<code>TRUE</code>) or not
(<code>FALSE</code>).</dd>


<dt>dateRange</dt>
<dd>A vector of two dates defining the desired study period.
Only the <code>start_date</code> column of the OMOP table is checked to ensure it falls within this range.
If <code>dateRange</code> is <code>NULL</code>, no restriction is applied.</dd>

</dl>

summariseInObservation: Summarise the number of people in observation during a specific interval of time

Description

Usage

Value

Arguments