Changelog

Source: NEWS.md

cchsflow 2.0.1 Unreleased

2021-11-01

Bug Fixes

  • Bug fixes to labelling in rec_with_table().
  • Corrections to specifications on variables.csv and variable_details.csv.

cchsflow 2.0.0 2021-10-25

2021-10-25

Features

  • Support for CCHS cycles up to 2018.

Bug Fixes

Variables

  • New ADL_01_A: Help preparing meals. Used for CCHS 2015-2016.
  • New ADL_02_A: Help appointments/errands. Used for CCHS 2015-2016.
  • New ADL_03_A: Help housework. Used for CCHS 2015-2016.
  • New ADL_04_A: Help personal care. Used for CCHS 2015-2016.
  • New ADL_05_A: Help move inside house. Used for CCHS 2015-2016.
  • New ADL_06_A: Help personal finances. Used for CCHS 2015-2016.
  • New ALC_005: In lifetime, ever drank alcohol? Used for CCHS 2001-2008 and 2015-2018.
  • New ALWDVSTR_der: Derived variable for short term risks due to drinking. Used for all CCHS cycles.
  • New ALWDVLTR_der: Derived variable for long term risks due to drinking. Used for all CCHS cycles.
  • New DEPDVSEV: Depression scale - severity of depression. Used for CCHS 2015-2018.
  • New diet_score_cat3: Derived variable for categorical diet score. Used for all CCHS cycles.
  • New EDUDR03: Derived variable for highest level/education - 3 categories. Used for all cycles.
  • New energy_exp: Daily energy expenditure. Used for all cycles.
  • New HUIDHSI_cat10: Categorical Health Utility Index into 10 categories. Used for CCHS 2001-2016.
  • New HUIDHSI_cat20: Categorical Health Utility Index into 20 categories. Used for CCHS 2001-2016.
  • New HUIDHSI_cat50: Categorical Health Utility Index into 50 categories. Used for CCHS 2001-2016.
  • New HWTGBMI_der_cat4: Derived variable for categorical body mass index into 4 categories. Used for all CCHS cycles.
  • New HWTGCOR: Adjusted BMI. Used for CCHS 2015-2018.
  • New HWTGCOR_der: Derived variable for adjusted BMI. Used for all CCHS cycles.
  • New immigration_der: Derived variable for immigration categories. Used for all CCHS cycles.
  • New low_drink_score: Derived variable for low risk drinking score. Used for all CCHS cycles.
  • New low_drink_score1: Derived variable for low risk drinking score that includes never drank and former drinker categories. Used for CCHS 2001-2008 and 2015-2018.
  • New PAA_045: Sweat/breathe harder exercises - hours - 7d (18+ years old). Used for CCHS 2015-2016.
  • New PAA_050: Sweat/breathe harder exercises - minutes - 7d (18+ years old). Used for CCHS 2015-2016.
  • New PAA_075: Other physical activities - hours - 7d (18+ years old). Used for CCHS 2015-2016.
  • New PAA_080: Other physical activities - minutes - 7d (18+ years old). Used for CCHS 2015-2016.
  • New PAADVDYS: Active days - 7d (18+ years old). Used for CCHS 2015-2016.
  • New PAADVVIG: Vigorous activity over a week (18+ years old). Used for CCHS 2015-2016.
  • New PAYDVADL: Leisure activities - minutes - 7d (12-17 years old). Used for CCHS 2015-2016.
  • New PAYDVDYS: Active days - 7d (12-17 years old). Used for CCHS 2015-2016.
  • New PAYDVTOA: Other physical activities - minutes - 7d (12-17 years old). Used for CCHS 2015-2016.
  • New PAYDVVIG: Vigorous activities - minutes - 7d (12-17 years old). Used for CCHS 2015-2016.
  • New pct_time_der_cat10: Categorical percentage of time in Canada. Used for all CCHS cycles.
  • New SMKDSTY_B: Smoker status into 5 categories. Used for CCHS 2015-2018.
  • New SMKDSTY_cat5: Smoker status into 5 categories. Used for all CCHS cycles.
  • New SMKG040: Age started to smoke daily - daily/former daily smoker. Used for CCHS 2015-2018.
  • New SMKG040_cont: Derived variable for age started to smoke daily - daily/former daily smoker. Used for all CCHS cycles.
  • New CCC_075: Do you have high blood cholesterol or lipids? Used for CCHS 2015-2018.

cchsflow 1.8.3 Unreleased

2021-08-20

Bug Fixes

cchsflow 1.8.2 2021-06-23

2021-06-23

Bug Fixes

New variable

  • SMKDSTY_cat3: 3 category smoking status derived variable.

cchsflow 1.8.1 Unreleased

2021-01-25

Bug Fixes

  • Correct breaking specification errors for diet_score.

cchsflow 1.8.0 2021-01-24

2021-01-22

Features

  • New function merge_rec_data() that merges and labels transformed CCHS datasets.

Minor improvements

  • Improved support for tagged_na in derived variables. Additional documentation added for creating derived variables in the tagged_na article.
  • Updates to labels and variable classification on variables.csv and variable_details.csv.

New variables

  • COPD_Emph_der: derived variable that determines if a respondent has either COPD or Emphysema.
  • ADL_score_5: derived variable that scores the number of daily tasks that a respondent needs help with.
  • diet_score: derived variable that scores respondents based on daily consumption of fruit, vegetables, and fruit juice.
  • smoke_simple: derived variable that identifies respondents smoking status.
  • time_quit_smoking: derived variable that estimates approximate time since respondent has quit smoking if they are a former smoker.
  • LBFA_31A/LBFA_31A_a/LBFA_31A_b: Occupation group. 3 different variables with differing categories were created to harmonize between CCHS cycles.
  • CCC_041: Fibromyalgia.
  • CCC_061: Back problems.
  • CCC_081: Migraine headaches.
  • CCC_290: Anxiety disorder.

cchsflow 1.7.1 Unreleased

2020-09-16

Minor improvements

  • Corrections to typos in tagged_na article.
  • Refactor recTo values for GEOGPRV to values specified in CCHS.

New variables

  • GEODPMF: Health region. Specified for the 2013-14 & 2014 CCHS cycles.
  • id_year: ID variable that appends data_name to ADM_RNO, creating a unique identifier for all respondents.

cchsflow 1.7.0 Unreleased

2020-09-11

Breaking changes

  • Notation in recFrom column of variable_details.csv is now changed to interval notation (e.g. 7:9 is now denoted as [7,9]).

Features

  • New description column added to variables.csv to allow a description of variables.
  • New role column added to variables.csv to allow users to set roles for variable manipulation.

New variables

Age:

  1. DHHGAGE_5: age variable categorized into 5 20-year age groups. Used in all CCHS cycles.
  2. DHHGAGE_D: age variable categorized into 8 10-year age groups. Used in all CCHS cycles.

Depression:

  1. DPSDPP: Depression Scale - Predicted Probability. Used in all CCHS cycles.
  2. DPSDSF: Depression Scale - Short Form Score. Used in all CCHS cycles
  3. DIS_10G: Frequency - distress: felt sad / depressed - past month. Used in CCHS cycles 2005-2014.
  4. DIS_10H: Frequency - distress: depressed/nothing cheers - past month. Used in CCHS cycles 2005-2014.
  5. DPSDMT: Specific month when felt depressed. Used in all CCHS cycles.
  6. DPSDWK: Number of weeks felt depressed - (D). Used in all CCHS cycles.
  7. DPS_02: Felt sad/blue/depressed - 2 weeks or more - 12 mo. Used in CCHS cycles 2007-2012.
  8. DPS_03: Sad/depressed - length feelings lasted - 2 wk. Used in CCHS cycles 2007-2012.
  9. DPS_04: Sad/depressed - frequency - 2 wk. Used in CCHS cycles 2007-2012.
  10. DPS_05: Sad/depressed - lose interest in things - 2 wk. Used in CCHS cycles 2007-2012.
  11. DPS_06: Sad/depressed - felt tired out / low on energy - 2 wk. Used in CCHS cycles 2007-2012.
  12. DPS_07: Sad/depressed - weight change - 2 wk. Used in CCHS cycles 2007-2012.
  13. DPS_08A: Sad/depressed - weight change (amount) - 2 wk. Used in CCHS cycles 2007-2012.
  14. DPS_08B: Sad/depressed - weight change (lb/kg) - 2 wk. Used in CCHS cycles 2007-2012.
  15. DPS_09: Sad/depressed - trouble falling asleep - 2 wk. Used in CCHS cycles 2007-2012.
  16. DPS_10: Sad/depressed trouble falling asleep - frequency - 2 wk. Used in CCHS cycles 2007-2012.
  17. DPS_11: Sad/depressed - trouble concentrating - 2 wk. Used in CCHS cycles 2007-2012.
  18. DPS_12: Sad/depressed - felt down on self - 2 wk. Used in CCHS cycles 2007-2012.
  19. DPS_13: Sad/depressed - thought a lot about death - 2 wk. Used in CCHS cycles 2007-2012.
  20. DPS_14: Sad/depressed - number of weeks - 12 mo. Used in CCHS cycles 2007-2012.

Influenza:

  1. FLU_160: Ever had a flu shot. Used in all CCHS cycles.
  2. FLU_162: Last time had flu shot. Used in all CCHS cycles.

cchsflow 1.6.0 2020-03-30

2020-03-30

Breaking changes

  • Refactored derived variable functions to handle tagged_na
  • Added new parameter ALW_1 to binge_drinker_fun()

Bug Fixes

  • Bug fix to resp_condition_fun1() that was not correctly handling respondents under 35 with respiratory conditions

Variables

  • New SDC_5A_1 - Knowledge of official languages. Used in CCHS cycles 2011-2014
  • New SDCDFOLS - First official language spoken. Used in CCHS cycles 2011-2014
  • New SDCGLHM - Languages spoken at home. Used in CCHS cycles 2007-2014
  • New SDCGLNG - Languages - can converse in. Used in CCHS cycles 2001-2010

cchsflow 1.5.2 Unreleased

2020-03-24

Bug Fixes

  • Fixes to typos in variables.csv & variable_details.csv

cchsflow 1.5.1 2020-03-20

2020-03-20

Minor improvements

  • Minor hotfix in description of package

cchsflow 1.5.0 Unreleased

2020-03-20

Breaking changes

  • Modified internal list index access to be compliant with R 4.0.
  • Added attach_data_name: new argument for adding data_name to rec_with_table() return

Variables

  • New ADL_der - derived “needs help with task” variable.
  • New RACDPAL_fun - custom function to derive RACDPAL for the 2001 CCHS survey cycle.
  • New ADL_07 - Needs help with heavy household chores. Recoded variable used in CCHS cycles 2001-2005.
  • New ADM_RNO - Sequential record number used in all CCHS cycles.
  • New RAC_2B - Reduction in activities at school or work due to disability variable used only in the 2001 CCHS survey cycle
  • New INCGPER_cont - continuous personal income variable harmonized across all CCHS cycles

Minor improvements

cchsflow 1.4.4 Unreleased

2020-03-03

Features

  • Docsearch added to website
  • New article on getting started with cchsflow

Bug fixes

  • Refactor to pct_time_fun function to output value from 0-100% as opposed to 0-1
  • Refactor to respiratory functions to better capture respondents under 35 with respiratory conditions

Minor improvements

  • Improvements to warning outputs in rec_with_table()
  • Improvements to labels in variables.csv & variable_details.csv

cchsflow 1.4.3 Unreleased

2020-02-21

Minor improvements

  • Minor documentation improvements in vignettes and home page

cchsflow 1.4.2 Unreleased

2020-02-19

Bug fixes and minor improvements

  • New badges and documentation updates to reflect package being added to CRAN
  • Fixed bug in rec_with_table() to include all values in recFrom column
  • Improvements in labelling of variables in variables.csv & variable_details.csv, as well as labelling of derived categorical variables

cchsflow 1.4.1 Unreleased

2020-02-11

Minor improvements

  • Suppressed warning messages in function examples
  • Minor edits & corrections to tagged_na, variable_details, and how to add variables articles.
  • Minor changes to titles of sample datasets
  • Minor refactor in rec_with_table() to match output type with specified toType for derived variables
  • Bug fixes to Reference page

cchsflow 1.4.0 Unreleased

2020-02-10

Breaking changes

  • Added to _p suffix to the names of datasets & databaseStarts to denote CCHS PUMF data

Features

  • Badges added to README.md with usethis.

Variables

  • New multiple conditions - derived multiple chronic conditions variable
  • Modifications to derived respiratory condition variable to include respondents with asthma.

Minor improvements

cchsflow 1.3.2 2020-02-16

2020-02-04

Variables

Minor improvements

cchsflow 1.3.1 Unreleased

2020-01-28

Variables

  • New CCC_31A. Ever diagnosed with cancer
  • New CCC_072. Ever diagnosed with hypertension
  • New CCC_073. Taken blood pressure medication in the last month
  • New HCU_1AA. Has regular medical doctor

cchsflow 1.3.0 Unreleased

2020-01-23

Breaking changes

Variables

  • New food_insecurity_der. Derived food insecurity variable.

Major improvements

  • message() is now used to print messages onto console. This enables the ability to easily suppress console output for testing purposes.

Minor improvements and bug fixes

  • Minor edits to DESCRIPTION

cchsflow 1.2.0 Unreleased

2020-01-13

Breaking changes

  • Changed dataset_name to database_name
  • Added a simple rec_with_table() function call that uses data variable name as database_name as well as default variables and variable_details that come with the package.

Minor improvements and bug fixes

  • Autolinked DOI in DESCRIPTION
  • Fixes to R chunks and minor edits in README.md
  • Modified tests and examples to use the new simplified rec_with_table() call
  • Modified vignettes to reflect use of new rec_with_table() call

cchsflow 1.1.0 Unreleased

2020-01-08

Breaking changes

  • Changed data_source parameter in rec_with_table() to data.

  • Changed order of parameters to have variables after dataset_name.

New features

  • Added warnings to set_data_labels() when a variable is present in details but missing in variables and vice versa.
  • Added automated testing for functions

Minor improvements and bug fixes

  • Updated DESCRIPTION to expand description of package and added The Ottawa Hospital as author.
  • Refactored age_cat_fun() to account for age below 0 and include warning messages for respiratory functions.
  • Added trailing white space removal to set_data_labels().
  • Added trailing white space removal to startVariable during rec_with_table().
  • Added missing contributing code of conduct page.
  • Minor formatting changes on vignettes and README.md for better clarity.
  • Fixed broken links in articles.

cchsflow 1.0.1 Unreleased

2019-12-19

Features

  • Updated LICENSE
  • Bug fixes to hyperlinks in README.md and NEWS.md

cchsflow 1.0.0 Unreleased

2019-12-18

News

  • Submitted package to CRAN

Features

  • Switched formatting to snake_case
  • Corrections to “using cchsflow” article
  • Removed DDI files

Dependency Changes

  • Dependency lowered to R 3.2
  • Dependency set for haven (>= 1.1.2)
  • Dependency set for dplyr (>= 0.8.2)
  • Dependency set for sjlabelled (>= 1.0.17)
  • Dependency set for stringr (>= 1.2.0)
  • Added bllflow functions to package to avoid dependency to package

cchsflow 0.2.3 Unreleased

2019-11-29

Features

  • Updated example in the introduction to reflect data that is now included in the cchsflow package.
  • Updates to vignettes to reflect latest version of package
  • Updates to variables.csv & variableDetails.csv

Variables

  • New DHHGAGE_C - categorical age variable that groups various age categories across all CCHS cycles. Based on the continuous age variable (DHHGAGE_cont) that is also harmonious across all CCHS cycles.
  • New WTS_M - sampling weight variable
  • New DHHGHSZ - household size
  • New INCGHH_A, INCGHH_B, INCGHH_C, INCGHH_cont - Total household income from all sources. The categories for household income vary across CCHS cycles so three categorical variables were added along with a continuous variable that harmonizes household income across all CCHS cycles by taking the midpoint of each category.

cchsflow 0.2.2 Unreleased

2019-11-26

Features

  • Updated ref branch of bllflow to match latest version of RecWTable()
  • Minor formatting changes in data, function, and derived variable documentation to improve readability
  • Minor corrections to derived variables article

cchsflow 0.2.1 Unreleased

2019-11-19

Features

  • Documentation for derived variable functions now available
  • Documentation for derived alcohol variables now available

cchsflow 0.2.0 Unreleased

Features

  • Added Support for derived variables alongside vignettes explaining how to add new variables
  • Added R file with custom functions for derived variables
  • Changed naming to support short database names ex. cchs2001
  • Added sample data for example purposes

cchsflow 0.1.0 (First Version) Unreleased

Features

  • Added variables.csv that contains list of CCHS variables in cchsflow.
  • Added variableDetails.csv that maps variables across CCHS cycles from 2001-2014
  • Added Vignettes to describe the process of using RecWTable(part of bllflow) to combine the data