View source: R/addDemographics.R
addDemographics | R Documentation |
Compute demographic characteristics at a certain date
addDemographics(
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",
name = NULL
)
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. |
name |
Name of the new table, if NULL a temporary table is returned. |
cohort table with the added demographic information columns.
library(PatientProfiles)
cdm <- mockPatientProfiles()
cdm$cohort1 %>%
addDemographics()
mockDisconnect(cdm = cdm)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.