Prepare for v3

.github/workflows/check-csv.yml

@@ -0,0 +1,40 @@
+name: Check CSV Formatting
+
+on:
+  pull_request:
+    paths:
+      - 'inst/extdata/variables.csv'
+      - 'inst/extdata/variable_details.csv'
+  push:
+    branches:
+      - main
+    paths:
+      - 'inst/extdata/variables.csv'
+      - 'inst/extdata/variable_details.csv'
+
+jobs:
+  check-csv-formatting:
+    runs-on: ubuntu-latest
+    name: Validate CSV worksheet formatting
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+
+      - name: Set up R
+        uses: r-lib/actions/setup-r@6f6e5bc62fba3a704f74e7ad7ef7676c5c6a2590
+        with:
+          r-version: 'release'
+
+      - name: Install package dependencies
+        uses: r-lib/actions/setup-r-dependencies@6f6e5bc62fba3a704f74e7ad7ef7676c5c6a2590
+        with:
+          extra-packages: local::.
+
+      - name: Check CSV formatting
+        run: Rscript exec/check-worksheets.R
+
+      - name: Suggest fix command on failure
+        if: failure()
+        run: |
+          echo "::error::CSV formatting violations detected. Run 'Rscript exec/fix-worksheets.R' locally to fix them."

CONTRIBUTING.md

@@ -2,6 +2,16 @@
 
 This page outlines how to contribute to the `cchsflow` package. 
 
+## Working with repo
+
+When working with the files within a folder, make sure to follow the
+instructions within the README.md file in that folder and folders above it if
+they exist.
+
+## Naming files
+
+Use kebab case when naming files. For example, `smoking-functions.R`
+
 ## Adding variables to cchsflow
 
 ### Transforming existing CCHS variables

DESCRIPTION

@@ -38,7 +38,11 @@ Depends:
   dplyr (>= 0.8.2),
   sjlabelled (>= 1.0.17),
   stringr (>= 1.2.0),
-  magrittr
+  magrittr,
+  yaml,
+  readr,
+  purrr,
+  cli
 Description: Supporting the use of the Canadian Community Health Survey 
              (CCHS) by transforming variables from each cycle into harmonized, 
              consistent versions that span survey cycles (currently, 2001 to 
@@ -53,7 +57,7 @@ Encoding: UTF-8
 LazyData: true
 URL: https://big-life-lab.github.io/cchsflow/, https://github.com/Big-Life-Lab/cchsflow
 BugReports: https://github.com/Big-Life-Lab/cchsflow/issues
-RoxygenNote: 7.1.2
+RoxygenNote: 7.3.3
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3

NAMESPACE

@@ -36,9 +36,11 @@ export(age_cat_fun)
 export(binge_drinker_fun)
 export(bmi_fun)
 export(bmi_fun_cat)
+export(check_worksheet)
 export(diet_score_fun)
 export(diet_score_fun_cat)
 export(energy_exp_fun)
+export(fix_worksheet)
 export(food_insecurity_der)
 export(if_else2)
 export(immigration_fun)

R/README.md

@@ -0,0 +1,30 @@
+## Naming files
+
+Files that contain a single public function should be named the same as the
+function but follow kebab case. For example, if the name of the public function
+is `pack_years_fun` then the file should be named `pack-years-fun.R`.
+
+## Naming private functions
+
+Functions that are not meant to be used by a package user should be named
+starting with a dot. For example, `.validate_function_args`.
+
+## Implicit Return
+
+Do not use implicit returns, instead explicitly use the `return` function.
+
+DO NOT DO THIS
+
+```{r}
+sum <- function(a, b) {
+  a + b
+}
+```
+
+DO THIS
+
+```{r}
+sum <- function(a, b) {
+  return(a + b)
+}
+```