Skip to contents

To add a new column with the cumulative quantity. To add multiple columns use addDrugUtilisation() for efficiency.

Source: R/addDrugUtilisation.R
addCumulativeQuantity.Rd

To add a new column with the cumulative quantity. To add multiple columns use addDrugUtilisation() for efficiency.

Usage

addCumulativeQuantity(
  cohort,
  conceptSet,
  indexDate = "cohort_start_date",
  censorDate = "cohort_end_date",
  restrictIncident = TRUE,
  nameStyle = "cumulative_quantity_{concept_name}",
  name = NULL
)

Arguments

cohort

A cohort_table object.

conceptSet

List of concepts to be included.

indexDate

Name of a column that indicates the date to start the analysis.

censorDate

Name of a column that indicates the date to stop the analysis, if NULL end of individuals observation is used.

restrictIncident

Whether to include only incident prescriptions in the analysis. If FALSE all prescriptions that overlap with the study period will be included.

nameStyle

Character string to specify the nameStyle of the new columns.

name

Name of the new computed cohort table, if NULL a temporary table will be created.

Value

The same cohort with the added column.

Examples

# \donttest{
cdm <- mockDrugUtilisation()
codelist <- CodelistGenerator::getDrugIngredientCodes(
  cdm,
  name = "acetaminophen"
)
cdm <- generateDrugUtilisationCohortSet(
  cdm = cdm, name = "dus_cohort", conceptSet = codelist
)
#> ℹ Subsetting drug_exposure table
#> ℹ Checking whether any record needs to be dropped.
#> ℹ Collapsing overlaping records.
#> ℹ Collapsing records with gapEra = 1 days.

cdm$dus_cohort |>
  addCumulativeQuantity(conceptSet = codelist)
#> # Source:   table<og_017_1743086284> [?? x 5]
#> # Database: DuckDB v1.2.1 [unknown@Linux 6.8.0-1021-azure:R 4.4.3/:memory:]
#>   cohort_definition_id subject_id cohort_start_date cohort_end_date
#>                  <int>      <int> <date>            <date>         
#> 1                    1          3 1994-01-08        2012-02-20     
#> 2                    1          6 1958-06-29        1958-08-23     
#> 3                    1          5 2020-11-01        2022-07-08     
#> 4                    1          5 2022-07-10        2022-07-10     
#> 5                    1          4 2022-07-26        2022-08-25     
#> 6                    1          7 2021-07-20        2021-09-12     
#> # ℹ 1 more variable: cumulative_quantity_161_acetaminophen <dbl>
# }