Load the Canadian Postsecondary Alcohol and Drug-use Survey (CPADS)
Source:R/datasets.R
morie_datasets_cpads.RdResolves a CPADS analysis frame from one of three sources:
Usage
morie_datasets_cpads(
offline = TRUE,
mode = c("datastore_search", "csv"),
limit = NULL,
q = NULL
)Arguments
- offline
Logical.
TRUE(default) prefers the included fixture for fast/CRAN-safe runs;FALSEfetches the live PUMF.- mode
Character; one of
"datastore_search"(default; queryable CKAN datastore endpoint, supportslimit/q) or"csv"(whole PUMF CSV download). Ignored whenoffline = TRUE.- limit
Integer or
NULL; row cap, forwarded todatastore_searchwhenmode = "datastore_search".NULLreturns the datastore default (100 rows).- q
Character or
NULL; free-text query forwarded todatastore_search(e.g.q = "title:jones"). Ignored formode = "csv".
Value
A data.frame carrying every CPADS PUMF column plus
morie's canonical analysis aliases (weight,
alcohol_past12m, heavy_drinking_30d, ebac_tot,
ebac_legal, cannabis_any_use, age_group, gender,
province_region, mental_health, physical_health).
Details
A pre-wrangled local RDS at
morie_cpads_contract()$expected_wrangled_path(only useful if you've already produced one), ORthe included 30-row real PUMF sample at
inst/extdata/cpads_pumf_synthetic.csv(whenoffline = TRUE, the default; carries all 394 raw PUMF columns plus the 11 morie canonical analysis aliases), ORthe live PUMF via the CKAN datastore_search API (default, supports
limit/q) or the full PUMF CSV (withmode = "csv"): https://open.canada.ca/data/dataset/736fa9b2-62e4-4e31-aea4-51869605b363/resource/d2639429-c304-45a6-90b3-770562f4d46d/download/cpads-2021-2022-pumf2.csv (whenoffline = FALSE).
CPADS is open data published by Health Canada / Statistics Canada (Open Government Licence – Canada). Aggregate dashboards at https://health-infobase.canada.ca/substance-use/reports/cpads/; PUMF user guide: https://open.canada.ca/data/dataset/736fa9b2-62e4-4e31-aea4-51869605b363/resource/a078e4c3-a910-4349-b00e-6ea0d31d391d/download/20212022-cpads-pumf-user-guide.pdf. Sister surveys (CSADS, CSUS, CTADS) are at https://health-infobase.canada.ca/substance-use/.
See also
morie_cpads_contract() for the canonical schema +
column map; morie_datasets_load_by_key() for catalog-wide
dispatch.
Examples
# \donttest{
df <- try(suppressWarnings(morie_datasets_cpads()))
if (!inherits(df, "try-error")) head(df)
#> SEQID stu04 region age_groups und_age pse1 dvstu01 dvstu02 dvdemq01 dvdemq02
#> 1 1 1 2 4 0 3 2 2 2 1
#> 2 2 1 2 2 0 3 2 2 1 1
#> 3 3 1 1 1 0 2 2 4 2 1
#> 4 4 1 4 4 0 3 1 4 2 1
#> 5 5 1 2 1 0 3 2 2 1 1
#> 6 6 1 2 1 0 2 1 98 1 1
#> dvdemq6 dvstu03 demq5 wtpumf hwbq01 hwbq02 alc01 alc03 alc04 alc05
#> 1 7 1 2 0.1000000 1 2 2 1 17 2
#> 2 6 1 2 0.1000000 3 2 2 1 18 1
#> 3 7 3 2 0.1268635 2 1 2 2 16 1
#> 4 7 3 2 0.1000000 4 2 2 1 8 2
#> 5 6 1 2 0.1000000 3 1 2 1 12 1
#> 6 2 2 2 0.1000000 5 1 2 1 14 1
#> covid1alc covid2aalc_1 covid2aalc_2 covid2aalc_3 covid2aalc_4 covid2aalc_5
#> 1 3 97 97 97 0 97
#> 2 1 1 97 97 97 97
#> 3 97 97 97 0 97 97
#> 4 97 97 0 97 1 97
#> 5 2 97 97 97 97 0
#> 6 3 97 97 97 97 97
#> covid2aalc_6 covid2aalc_7 covid2aalc_8 covid2aalc_9 covid2aalc_10
#> 1 0 97 97 97 0
#> 2 97 97 97 97 97
#> 3 97 97 97 97 97
#> 4 97 97 97 97 97
#> 5 97 97 0 97 0
#> 6 97 0 0 97 0
#> covid2aalc_11 covid2balc_1 covid2balc_2 covid2balc_3 covid2balc_4
#> 1 97 97 97 0 97
#> 2 97 97 97 97 97
#> 3 97 97 0 97 97
#> 4 97 97 97 0 97
#> 5 97 97 0 97 97
#> 6 97 97 97 97 97
#> covid2balc_5 covid2balc_6 covid2balc_7 covid2balc_8 covid2balc_9
#> 1 97 0 1 97 97
#> 2 97 97 0 0 0
#> 3 97 97 0 1 0
#> 4 97 97 97 97 97
#> 5 97 97 97 97 97
#> 6 97 0 97 97 97
#> covid2balc_10 covid2balc_11 covid2balc_12 covid2balc_13 covid2balc_14
#> 1 97 97 97 97 97
#> 2 97 0 0 97 97
#> 3 97 1 97 0 0
#> 4 97 97 0 97 97
#> 5 97 97 97 97 97
#> 6 97 0 97 97 0
#> covid2balc_15 covid3alc alc08_a alc08_b alc08_c alc08_d alc08_e alc06 alc10
#> 1 0 1 1 2 2 97 2 97 1
#> 2 97 97 2 1 2 2 99 6 1
#> 3 97 2 1 2 2 2 97 4 1
#> 4 97 2 1 97 2 1 2 6 997
#> 5 97 2 2 1 2 97 2 97 8
#> 6 97 1 1 2 2 2 2 3 5
#> alc07 alc09_a alc09_b alc09_c alc09_d alc09_e alc09_f alc09_g alc09_h alc11a
#> 1 17 6 6 6 97 6 6 97 6 1
#> 2 0 97 3 6 97 6 5 6 6 97
#> 3 0 6 5 5 97 4 6 97 97 97
#> 4 0 99 97 6 97 6 97 97 2 1
#> 5 999 6 6 5 3 6 6 6 5 1
#> 6 997 97 97 6 97 2 6 97 4 97
#> alc11b alc18 alc12f alc12m alc13a alc13b_a alc13b_b alc14 alc15 alc16a alc16b
#> 1 4 2 97 97 997 8 0 1 13 97 97
#> 2 97 2 6 97 997 6 997 1 19 6 3
#> 3 1 2 97 97 7 997 0 1 14 97 97
#> 4 1 2 5 97 997 6 0 1 997 6 5
#> 5 97 97 97 6 5 1 0 1 997 5 4
#> 6 2 97 97 97 3 1 997 1 15 97 6
#> alc17 aed01_a aed01_b aed01_c aed01_d aed01_e alcdr01 alcdr03 alcdr04 alcdr02
#> 1 8 6 97 6 6 5 4 1 1 4
#> 2 97 6 6 6 6 6 4 1 3 97
#> 3 4 3 6 6 97 97 3 1 1 2
#> 4 97 6 6 97 6 97 3 1 1 97
#> 5 97 6 6 6 6 6 4 1 1 4
#> 6 3 5 6 6 6 6 4 1 1 4
#> ahs_a ahs_b ahs_c ahs_d ahs_e ahs_f ahs_g ahs_h ahs_i ahs_j ahs_k ahs_l ahs_m
#> 1 2 1 1 2 1 1 2 2 1 97 97 1 1
#> 2 1 2 2 3 2 2 3 1 97 97 1 1 97
#> 3 1 1 2 2 1 97 1 97 97 97 1 1 1
#> 4 1 97 97 97 97 2 97 1 97 1 1 1 1
#> 5 99 1 2 2 1 1 97 1 3 1 1 1 97
#> 6 1 97 2 98 1 3 1 1 1 1 1 1 2
#> ahs_n ahs_o ahs_p ahs_q ahs_r ahs_s ahs_t ahs_u ahs_v ahs_w ahs_x ahs_y ahs_z
#> 1 1 2 2 3 1 1 2 1 1 98 1 97 1
#> 2 97 2 1 97 1 1 2 99 1 1 1 1 3
#> 3 2 1 3 2 97 1 97 1 97 1 97 1 97
#> 4 1 97 1 3 2 1 97 1 1 1 1 1 1
#> 5 99 1 2 97 1 1 1 2 2 1 1 2 97
#> 6 3 3 2 1 3 1 97 1 97 1 1 1 1
#> ahs_aa ahs_ab aho_a aho_b aho_c aho_d aho_e aho_f aho_g aho_h aho_i aho_j
#> 1 1 97 1 2 1 2 1 1 98 1 1 2
#> 2 1 1 1 1 2 1 1 1 1 1 2 2
#> 3 1 1 1 1 2 3 1 1 1 2 1 1
#> 4 1 1 1 1 1 1 1 1 1 2 1 3
#> 5 97 1 1 1 1 2 1 2 1 1 2 1
#> 6 1 1 1 1 1 1 1 1 1 1 2 1
#> aho_k apb_a apb_b apb_c apb_d apb_e apb_f apb_g apb_h apb_i apb_j apb_k apb_l
#> 1 1 5 2 4 2 3 97 2 6 3 5 3 97
#> 2 1 4 2 97 1 4 2 6 2 4 97 4 1
#> 3 1 97 3 97 97 4 4 6 4 6 97 4 5
#> 4 1 5 3 5 5 97 1 97 97 97 5 4 1
#> 5 1 4 4 97 3 5 1 3 3 97 5 6 2
#> 6 1 2 1 6 6 97 97 1 3 97 4 3 4
#> apb_m apb_n apb_o apb_p apb_q apb_r apb_s can01_1 can01_2 can01_3 can01_4
#> 1 97 6 97 97 97 5 5 0 1 99 0
#> 2 97 1 97 2 97 3 5 0 0 0 0
#> 3 5 97 97 97 1 97 5 1 98 0 1
#> 4 97 97 97 3 97 97 1 1 0 0 0
#> 5 1 5 97 97 97 97 97 0 99 0 0
#> 6 5 1 6 3 2 5 97 1 1 0 0
#> can01_5 can01_6 can01_7 can01_8 can01_9 can01_10 can01_11 can01_12 can01_13
#> 1 99 0 0 0 99 0 99 0 0
#> 2 0 0 1 0 0 1 1 1 0
#> 3 0 0 0 0 0 1 0 0 0
#> 4 0 0 1 99 0 0 0 0 1
#> 5 99 0 0 0 0 0 0 0 0
#> 6 0 0 0 99 0 0 0 0 0
#> can01_14 can01_15 can02_a can02_b can02_c can02_d can02_e can02_f can02_g
#> 1 0 0 1 1 1 1 2 1 2
#> 2 0 0 1 1 2 1 1 1 1
#> 3 0 0 1 1 1 1 99 99 99
#> 4 0 0 1 1 1 1 2 1 99
#> 5 0 0 1 1 1 1 1 98 99
#> 6 0 0 1 2 1 1 99 1 1
#> can02_h can02_i can04a can04b can04c can05 can17 can08 covid1can covid2acan_1
#> 1 1 99 4 97 97 1 4 1 1 1
#> 2 1 2 2 1 97 1 2 1 97 97
#> 3 1 99 1 97 97 2 1 3 97 97
#> 4 1 98 1 97 97 2 1 3 3 0
#> 5 99 2 5 97 97 1 1 97 1 97
#> 6 1 99 2 2 1 1 97 97 97 97
#> covid2acan_2 covid2acan_3 covid2acan_4 covid2acan_5 covid2acan_6 covid2acan_7
#> 1 97 97 97 97 97 97
#> 2 97 97 97 97 1 97
#> 3 97 97 1 97 97 97
#> 4 1 97 97 97 1 0
#> 5 97 97 97 97 97 97
#> 6 97 97 1 97 97 97
#> covid2acan_8 covid2acan_9 covid2acan_10 covid2acan_11 covid2acan_12
#> 1 97 97 97 97 97
#> 2 0 97 97 0 0
#> 3 97 97 97 97 97
#> 4 97 97 97 97 97
#> 5 97 97 97 0 0
#> 6 97 0 97 97 97
#> covid2acan_13 covid2bcan_1 covid2bcan_2 covid2bcan_3 covid2bcan_4
#> 1 97 97 97 97 97
#> 2 97 97 97 97 97
#> 3 97 97 97 0 97
#> 4 97 97 97 0 97
#> 5 97 97 97 97 97
#> 6 97 97 97 97 97
#> covid2bcan_5 covid2bcan_6 covid2bcan_7 covid2bcan_8 covid2bcan_9
#> 1 97 97 97 97 1
#> 2 97 97 97 97 97
#> 3 97 97 97 97 97
#> 4 0 97 97 97 97
#> 5 97 97 97 97 97
#> 6 0 97 97 97 97
#> covid2bcan_10 covid2bcan_11 covid2bcan_12 covid2bcan_13 covid3can can07 can06
#> 1 97 97 97 97 97 997 97
#> 2 97 97 97 97 1 997 97
#> 3 97 97 97 97 3 16 3
#> 4 0 97 97 97 97 997 2
#> 5 97 97 97 97 97 997 97
#> 6 97 97 97 97 97 997 97
#> can20a_1 can20a_2 can20a_3 can20a_4 can20a_5 can20a_6 can20a_7 can20a_8
#> 1 97 1 97 0 97 0 97 97
#> 2 97 1 97 97 97 0 0 97
#> 3 1 97 97 97 0 97 97 97
#> 4 97 0 0 0 0 97 97 0
#> 5 97 97 97 97 1 97 0 97
#> 6 97 97 0 0 97 97 0 97
#> can20b_1 can20b_2 can20b_3 can20b_4 can21 can10 can11a_1 can11a_2 can11a_3
#> 1 0 97 97 97 97 97 1 97 0
#> 2 97 97 97 0 97 97 97 97 97
#> 3 97 0 97 0 97 97 97 97 1
#> 4 0 97 0 97 97 1 0 99 0
#> 5 1 97 97 97 97 97 97 97 0
#> 6 97 97 97 97 3 97 97 1 97
#> can11a_4 can11a_5 can11a_6 can11a_7 can11a_8 can11a_9 can11b_a can11b_b
#> 1 97 97 97 97 0 0 8 97
#> 2 97 97 1 97 97 97 97 3
#> 3 97 1 97 0 99 97 97 97
#> 4 0 97 97 0 97 97 97 97
#> 5 97 1 1 1 97 99 97 97
#> 6 97 97 97 0 97 97 97 97
#> can11b_c can11b_d can11b_e can11b_f can11b_g can11b_h can11b_i can14_a
#> 1 97 97 97 97 97 97 97 97
#> 2 97 5 97 97 97 97 97 1
#> 3 97 97 2 97 97 97 97 97
#> 4 3 97 97 97 97 97 97 97
#> 5 97 97 97 97 97 97 97 1
#> 6 97 97 2 97 97 97 97 97
#> can14_b can14_d can14_e can14_f can14_g can14_h can14_i can14_j can12 can13
#> 1 97 1 97 97 97 97 1 97 9 5
#> 2 1 1 97 97 97 1 2 1 3 97
#> 3 1 97 97 1 97 97 97 1 3 5
#> 4 97 1 97 97 1 97 97 97 97 97
#> 5 2 97 1 97 97 2 1 97 9 97
#> 6 1 1 97 97 1 97 1 1 3 97
#> can04 can16 can18 can19_1 can19_2 can19_3 can19_4 can19_5 can19_6 can19_7
#> 1 4 97 97 97 0 97 97 97 97 97
#> 2 4 2 3 97 97 97 97 97 97 97
#> 3 4 4 3 97 97 97 97 97 1 97
#> 4 4 97 3 1 97 0 97 97 97 97
#> 5 2 97 97 97 0 97 97 97 97 97
#> 6 4 3 97 97 0 97 97 97 97 97
#> can19_8 can19_9 can19_10 can19_11 can19_12 caa00 caa01 caa02 caa03 caa04
#> 1 97 97 97 97 97 97 2 1 1 1
#> 2 97 97 97 97 97 2 97 97 97 97
#> 3 97 97 97 97 0 2 2 97 1 97
#> 4 97 97 97 97 97 3 97 97 97 1
#> 5 0 97 97 97 97 5 97 97 97 1
#> 6 97 97 97 97 97 97 97 1 1 1
#> caa05 opi01 opi01b_1 opi01b_2 opi01b_3 opi01b_5 opi01b_6 opi01b_7 opi01b_9
#> 1 97 3 1 97 0 97 97 97 0
#> 2 97 3 97 97 97 97 97 97 97
#> 3 97 2 1 1 97 97 97 97 99
#> 4 97 3 99 97 97 0 99 97 0
#> 5 97 3 1 97 97 0 0 97 97
#> 6 1 4 97 97 97 97 97 97 97
#> opi02 opi03 opi04a opi04b opi05 opi06 opi08_1 opi08_2 opi08_3 opi08_7 opi08_8
#> 1 4 4 4 97 97 97 97 97 97 97 97
#> 2 97 97 97 97 97 97 97 97 97 97 97
#> 3 97 97 97 97 97 4 97 97 97 97 97
#> 4 4 97 97 97 1 97 97 97 97 97 97
#> 5 97 97 97 97 97 97 1 97 97 97 97
#> 6 97 97 97 97 97 97 97 99 97 97 99
#> opi08_9 sti01 sti02 sti03 sti04a sti04b sti05 sti06 sti08_1 sti08_2 sti08_3
#> 1 98 4 4 97 97 97 97 97 97 97 0
#> 2 97 4 4 97 97 97 97 97 97 97 97
#> 3 97 4 4 97 97 2 97 4 97 97 97
#> 4 99 1 1 97 97 97 2 97 97 97 97
#> 5 97 4 97 97 97 97 97 97 97 97 97
#> 6 97 4 97 97 97 97 97 97 97 97 97
#> sti08_7 sti08_8 sti08_9 sti08_13 sed01 sed02 sed03 sed04a sed04b sed05 sed06
#> 1 97 97 97 97 4 97 4 3 97 97 97
#> 2 97 97 97 97 4 97 97 97 97 97 97
#> 3 97 97 97 97 2 4 97 97 97 97 97
#> 4 97 97 97 97 4 97 97 97 97 97 97
#> 5 97 97 97 97 1 97 97 97 97 97 97
#> 6 0 97 97 97 4 4 97 97 97 97 97
#> sed08_1 sed08_2 sed08_3 sed08_7 sed08_8 sed08_9 sed08_13 oth01 dru01_a
#> 1 97 97 97 97 97 97 97 2 1
#> 2 97 97 97 97 97 97 97 2 1
#> 3 97 97 0 97 97 97 97 2 1
#> 4 97 97 97 97 97 97 97 2 1
#> 5 97 97 97 97 97 97 97 2 1
#> 6 97 97 97 97 97 97 97 2 1
#> dru01_b dru01_c dru01_d dru01_e dru01_f dru01_g dru01_h dru01_i dru01_j
#> 1 1 1 98 1 1 1 1 1 1
#> 2 1 1 1 1 1 1 1 1 1
#> 3 1 3 1 2 2 1 1 1 1
#> 4 1 1 1 1 3 1 1 1 1
#> 5 1 1 1 1 1 1 1 1 1
#> 6 1 1 1 1 1 1 1 1 1
#> dru01_k dru01_l dru02 dru03 dru04 dru05 dha01_a dha01_b dha01_c dha01_d
#> 1 1 1 1 1 1 2 97 97 2 97
#> 2 1 1 1 1 1 2 2 97 97 2
#> 3 1 1 3 1 1 2 2 2 97 97
#> 4 1 1 1 1 1 2 97 97 97 2
#> 5 1 1 1 1 1 2 2 2 97 2
#> 6 1 1 1 1 1 2 97 97 97 97
#> dha01_e dha02 dha03 dha04 tre01_1 tre01_2 tre01_3 tre01_4 tre02_1 tre02_2
#> 1 97 2 2 1 0 0 0 1 1 97
#> 2 97 2 97 97 0 0 0 1 97 97
#> 3 97 2 97 2 0 0 0 1 97 97
#> 4 97 2 97 1 0 0 0 1 97 97
#> 5 2 97 2 97 0 0 0 1 97 97
#> 6 97 97 97 97 0 0 0 1 97 0
#> tre02_3 tre02_4 tre03_1 tre03_2 tre03_3 tre03_4 tre03_5 tre03_6 tre03_7
#> 1 97 97 97 97 97 97 0 97 97
#> 2 97 97 97 97 97 97 0 97 97
#> 3 97 97 97 97 1 97 97 97 97
#> 4 97 97 97 97 97 1 97 97 97
#> 5 97 97 97 97 97 97 97 97 97
#> 6 97 97 97 97 97 97 97 97 97
#> tre03_8 tre03_9 kab02 kab03 kab04 tob02 tob03 tob04 vap01 vap03 h_grp mh_grp
#> 1 97 97 2 2 97 2 97 97 4 5 1 0
#> 2 97 97 2 2 97 2 97 1 5 97 0 0
#> 3 97 97 2 97 97 1 97 97 5 97 1 1
#> 4 97 97 2 2 97 1 4 1 4 7 1 1
#> 5 97 97 2 97 97 2 97 97 4 97 1 1
#> 6 97 97 1 97 97 1 97 97 4 97 1 0
#> promotion u_d_lrdg alc12_30d_freq alc12_30d_prev alc12_30d_prev_total
#> 1 0 97 3 1 1
#> 2 1 97 1 1 0
#> 3 0 97 2 97 0
#> 4 0 97 2 1 0
#> 5 1 0 97 1 97
#> 6 0 97 1 1 1
#> alc13_lrdg energy_prev alcensep_prev alcenhand_prev alcenmix_prev
#> 1 97 1 97 0 0
#> 2 1 0 0 0 0
#> 3 1 0 97 0 1
#> 4 1 0 0 0 97
#> 5 1 0 99 0 97
#> 6 97 0 0 97 0
#> alcmixnrg3_prev alcensweet_prev ahs30d ahs_sch ahs_dependence ahs_phy aho30d
#> 1 0 97 1 0 0 1 0
#> 2 0 0 97 97 0 0 0
#> 3 0 0 0 0 0 0 0
#> 4 0 97 0 0 1 97 0
#> 5 0 0 0 0 0 97 1
#> 6 0 0 99 0 0 0 1
#> aho_violence aho_disr apb30d can_assist opi12m_problem stim12m_problem
#> 1 0 0 1 2 97 97
#> 2 0 0 1 2 97 97
#> 3 0 0 1 2 97 97
#> 4 0 0 97 1 0 97
#> 5 0 0 1 2 0 97
#> 6 0 0 1 97 0 97
#> sed12m_problem ebac_tot ebac_legal
#> 1 0 NA NA
#> 2 97 0.11 1
#> 3 97 NA 1
#> 4 97 0.03 1
#> 5 97 0.23 NA
#> 6 97 NA NA
# }