Merge pull request #79 from RSGInc/76-update-hts_summary_cat-and-hts_…

…summary-examples 76 update hts summary cat and hts summary examples
RSGInc · Jan 26, 2024 · e159a03 · e159a03
2 parents 903238b + f9d1912
commit e159a03
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 8 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -7,3 +7,5 @@
 ^CONTRIBUTING.md$
 ^LICENSE.md$
 ^scratch.R
+^_pkgdown.yml
+^docs
diff --git a/R/hts_summary.R b/R/hts_summary.R
@@ -67,7 +67,22 @@
 #'               summarize_by = 'age',
 #'               summarize_vartype = 'numeric',
 #'               wtname = 'trip_weight')
-#'             
+#'
+#' DT = hts_prep_data(summarize_var = 'race',
+#'                    summarize_by = 'age', 
+#'                    variables_dt = variable_list,
+#'                    data = list('hh' = hh,
+#'                                'person' = person,
+#'                                'day' = day,
+#'                                'trip' = trip,
+#'                                'vehicle' = vehicle))$cat
+#' output = hts_summary(prepped_dt = DT,
+#'               summarize_var = 'race',
+#'               summarize_by = 'age',
+#'               summarize_vartype = 'categorical',
+#'               wtname = 'person_weight',
+#'               checkbox_valname = 'value',
+#'               checkbox_yesval = 1)             
 
 
 hts_summary = function(

diff --git a/R/hts_summary_cat.R b/R/hts_summary_cat.R
@@ -40,7 +40,8 @@
 #' hts_summary_cat(prepped_dt = DT,
 #'                 summarize_var = 'age',
 #'                 wtname = 'person_weight')
-#' DT = hts_prep_data(summarize_var = 'age',
+#'                 
+#' DT = hts_prep_data(summarize_var = 'race',
 #'                    summarize_by = 'employment',
 #'                    variables_dt = variable_list,
 #'                    data = list('hh' = hh,
@@ -49,9 +50,11 @@
 #'                                'trip' = trip,
 #'                                'vehicle' = vehicle))$cat
 #' hts_summary_cat(prepped_dt = DT,
-#'                 summarize_var = 'age',
+#'                 summarize_var = 'race',
 #'                 summarize_by = 'employment',
-#'                 wtname = 'person_weight')
+#'                 wtname = 'person_weight',
+#'                 checkbox_valname = 'value',
+#'                 checkbox_yesval = 1)
 #'                 
 #' DT = hts_prep_data(summarize_var = 'employment',
 #'                 summarize_by = c('race', 'income_detailed', 'gender'),

diff --git a/man/hts_summary.Rd b/man/hts_summary.Rd
diff --git a/man/hts_summary_cat.Rd b/man/hts_summary_cat.Rd