Query to add demographic characteristics at a certain date

`r lifecycle::badge("experimental")` Same as `addDemographics()`, except query is not computed to a table.

Usage

addDemographicsQuery(
  x,
  indexDate = "cohort_start_date",
  age = TRUE,
  ageName = "age",
  ageMissingMonth = 1,
  ageMissingDay = 1,
  ageImposeMonth = FALSE,
  ageImposeDay = FALSE,
  ageGroup = NULL,
  missingAgeGroupValue = "None",
  sex = TRUE,
  sexName = "sex",
  missingSexValue = "None",
  priorObservation = TRUE,
  priorObservationName = "prior_observation",
  priorObservationType = "days",
  futureObservation = TRUE,
  futureObservationName = "future_observation",
  futureObservationType = "days",
  dateOfBirth = FALSE,
  dateOfBirthName = "date_of_birth"
)

Arguments

x

Table with individuals in the cdm.

indexDate

Variable in x that contains the date to compute the demographics characteristics.

age

TRUE or FALSE. If TRUE, age will be calculated relative to indexDate.

ageName

Age variable name.

ageMissingMonth

Month of the year assigned to individuals with missing month of birth.

ageMissingDay

day of the month assigned to individuals with missing day of birth.

ageImposeMonth

TRUE or FALSE. Whether the month of the date of birth will be considered as missing for all the individuals.

ageImposeDay

TRUE or FALSE. Whether the day of the date of birth will be considered as missing for all the individuals.

ageGroup

if not NULL, a list of ageGroup vectors.

missingAgeGroupValue

Value to include if missing age.

sex

TRUE or FALSE. If TRUE, sex will be identified.

sexName

Sex variable name.

missingSexValue

Value to include if missing sex.

priorObservation

TRUE or FALSE. If TRUE, days of between the start of the current observation period and the indexDate will be calculated.

priorObservationName

Prior observation variable name.

priorObservationType

Whether to return a "date" or the number of "days".

futureObservation

TRUE or FALSE. If TRUE, days between the indexDate and the end of the current observation period will be calculated.

futureObservationName

Future observation variable name.

futureObservationType

Whether to return a "date" or the number of "days".

dateOfBirth

TRUE or FALSE, if true the date of birth will be return.

dateOfBirthName

dateOfBirth column name.

Value

cohort table with the added demographic information columns.

Examples

# \donttest{
library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addDemographicsQuery()
#> # Source:   SQL [?? x 8]
#> # Database: DuckDB 1.4.1 [unknown@Linux 6.11.0-1018-azure:R 4.5.1/:memory:]
#>    cohort_definition_id subject_id cohort_start_date cohort_end_date   age sex  
#>                   <int>      <int> <date>            <date>          <int> <chr>
#>  1                    2          1 1971-01-19        1971-11-10         23 Male 
#>  2                    1          2 1958-05-14        1976-03-02         16 Fema…
#>  3                    2          3 1953-02-11        1955-08-22          3 Fema…
#>  4                    1          4 1942-05-13        1958-02-01         23 Male 
#>  5                    2          5 1963-11-11        1968-01-11         17 Fema…
#>  6                    3          6 1926-09-23        1950-12-05          4 Fema…
#>  7                    2          7 1926-10-03        1932-02-25          8 Fema…
#>  8                    1          8 1987-08-20        1992-08-13         12 Male 
#>  9                    1          9 1950-02-05        1965-11-03         20 Fema…
#> 10                    3         10 1966-11-03        1991-02-27          4 Male 
#> # ℹ 2 more variables: prior_observation <int>, future_observation <int>

# }