Merge pull request #3 from Big-Life-Lab/social-isolation

Add derive_sii, update CLSA reference in docs

Author: reikookamoto

DESCRIPTION

@@ -11,7 +11,6 @@ Description: What the package does (one paragraph).
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
 Imports: 
     dplyr,
     glue,
@@ -27,3 +26,4 @@ Suggests:
 Config/testthat/edition: 3
 URL: https://big-life-lab.github.io/clsatools/, https://github.com/Big-Life-Lab/clsatools
 VignetteBuilder: knitr
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -5,6 +5,7 @@ export(derive_adl_dcls)
 export(derive_cag_fpas)
 export(derive_cr1_frhc)
 export(derive_cr2_frhc)
+export(derive_sii)
 export(derive_sls_dcls)
 export(find_matching_pairs)
 export(recode_missing)

R/derive_adl_dcls.R

@@ -12,9 +12,11 @@
 #' Intended for use with Follow-up 2 data, for which this variable was not
 #' derived by the data provider.
 #'
-#' @references [Derived Variables - Basic Activities of Daily Living (ADL) &
-#' Instrumental Activities of Daily Living
-#' (IAL)](https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_adl_10aug2018.pdf)
+#' @references
+#' Canadian Longitudinal Study on Aging. Derived Variables — Basic
+#' Activities of Daily Living (ADL) & Instrumental Activities of Daily
+#' Living (IAL). 2018.
+#' \url{https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_adl_10aug2018.pdf}
 #'
 #' @export
 #' @examples

R/derive_cag_fpas.R

@@ -29,8 +29,10 @@
 #' `CAG_HLT_HC`) are excluded from the function because they are unavailable at
 #' Follow-up 2.
 #'
-#' @references [Derived Variables – Care Giving
-#' (CAG)](https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_caregiv_v1.4_2019feb01.pdf)
+#' @references
+#' Canadian Longitudinal Study on Aging. Derived Variables — Care Giving
+#' (CAG). 2019.
+#' \url{https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_caregiv_v1.4_2019feb01.pdf}
 #'
 #' @export
 #' @examples

R/derive_cr1_frhc.R

@@ -27,8 +27,11 @@
 #' algorithm (`CR1_PRO_MC` and `CR1_PRO_MISSING`) are excluded from the function
 #' because they are unavailable at Follow-up 2.
 #'
-#' @references [Derived Variables – Care Receiving 1/Formal Care
-#' (CR1)](https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_cr_4dec2017.pdf)
+#' @references
+#' Canadian Longitudinal Study on Aging. Derived Variables — Care
+#' Receiving 1/Formal Care (CR1) & Care Receiving 2/Informal Care (CR2).
+#' 2017.
+#' \url{https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_cr_4dec2017.pdf}
 #'
 #' @export
 #' @examples

R/derive_cr2_frhc.R

@@ -25,8 +25,11 @@
 #' algorithm (`CR2_FAM_CS`, `CR2_FAM_MB`, `CR2_FAM_MISSING`, and `CR2_FAM_MN`)
 #' are excluded from the function because they are unavailable at Follow-up 2.
 #'
-#' @references [Derived Variables – Care Receiving 2/Informal Care (CR2)
-#' ](https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_cr_4dec2017.pdf)
+#' @references
+#' Canadian Longitudinal Study on Aging. Derived Variables — Care
+#' Receiving 1/Formal Care (CR1) & Care Receiving 2/Informal Care (CR2).
+#' 2017.
+#' \url{https://www.clsa-elcv.ca/wp-content/uploads/2023/06/dv_cr_4dec2017.pdf}
 #'
 #' @export
 #' @examples