added warning message to remove outliers and defaulted to false in pr…

…ep triprate #159
RSGInc · Jun 17, 2024 · 22d3d06 · 22d3d06
1 parent 625e8cc
commit 22d3d06
Show file tree

Hide file tree

Showing 19 changed files with 140 additions and 129 deletions.
diff --git a/R/hts_prep_triprate.R b/R/hts_prep_triprate.R
@@ -55,7 +55,7 @@ hts_prep_triprate = function(summarize_by = NULL,
                              day_name = "day",
                              ids = c("hh_id", "person_id", "day_id", "trip_id", "vehicle_id"),
                              wts = c("hh_weight", "person_weight", "day_weight", "trip_weight", "hh_weight"),
-                             remove_outliers = TRUE,
+                             remove_outliers = FALSE,
                              threshold = 0.975,
                              weighted = TRUE,
                              hts_data = list(hts_data)) {

diff --git a/R/hts_remove_outliers.R b/R/hts_remove_outliers.R
@@ -11,10 +11,12 @@
 #' @examples
 #'
 #' require(data.table)
+#' 
 #' hts_remove_outliers(var_dt = trip, numvar = "speed_mph")
 #'
 hts_remove_outliers = function(var_dt, numvar = NULL,
                                 threshold = 0.975) {
+
   outlier_storage = list()
 
   outlier_cutoff = quantile(var_dt[, get(numvar)], threshold, na.rm = TRUE)
@@ -26,6 +28,12 @@ hts_remove_outliers = function(var_dt, numvar = NULL,
     max_outlier = max(var_dt[get(numvar) >= outlier_cutoff, get(numvar)])
   )
 
+  if (outlier_table$num_removed > 0) {
+    warning(stringr::str_glue(
+      "{outlier_table$num_removed} outliers were removed based on the threshold of {threshold}."
+    ))
+  }
+
   outlier_storage[["outlier_description"]] = outlier_table
 
   outlier_storage[["dt"]] = var_dt[get(numvar) < outlier_cutoff]

diff --git a/docs/articles/a01_getting_started.html b/docs/articles/a01_getting_started.html
diff --git a/docs/articles/a01_getting_started_files/figure-html/ggplot_example-1.png b/docs/articles/a01_getting_started_files/figure-html/ggplot_example-1.png
diff --git a/docs/articles/a03_trip_rates.html b/docs/articles/a03_trip_rates.html
diff --git a/docs/articles/a03_trip_rates_files/figure-html/trip_rate_job_type-1.png b/docs/articles/a03_trip_rates_files/figure-html/trip_rate_job_type-1.png
diff --git a/docs/articles/a03_trip_rates_files/figure-html/trip_rate_race_ethnicity-1.png b/docs/articles/a03_trip_rates_files/figure-html/trip_rate_race_ethnicity-1.png
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,7 +5,7 @@ articles:
   a01_getting_started: a01_getting_started.html
   a02_geographic_summaries: a02_geographic_summaries.html
   a03_trip_rates: a03_trip_rates.html
-last_built: 2024-06-17T16:33Z
+last_built: 2024-06-17T16:55Z
 urls:
   reference: https://rsginc.github.io/travelSurveyTools/reference
   article: https://rsginc.github.io/travelSurveyTools/articles

diff --git a/docs/reference/hts_prep_triprate.html b/docs/reference/hts_prep_triprate.html
diff --git a/docs/reference/hts_prep_variable.html b/docs/reference/hts_prep_variable.html
diff --git a/docs/reference/hts_remove_outliers.html b/docs/reference/hts_remove_outliers.html
diff --git a/docs/reference/hts_summary.html b/docs/reference/hts_summary.html
diff --git a/docs/reference/hts_summary_num.html b/docs/reference/hts_summary_num.html
diff --git a/docs/reference/hts_summary_wrapper.html b/docs/reference/hts_summary_wrapper.html
diff --git a/docs/reference/hts_trip_vehid.html b/docs/reference/hts_trip_vehid.html
diff --git a/docs/search.json b/docs/search.json
diff --git a/man/hts_prep_triprate.Rd b/man/hts_prep_triprate.Rd
diff --git a/man/hts_remove_outliers.Rd b/man/hts_remove_outliers.Rd
diff --git a/tests/testthat/test_hts_prep_triprate.R b/tests/testthat/test_hts_prep_triprate.R
@@ -7,6 +7,7 @@ test_that("hts_prep_triprate should return counts and units", {
   results = hts_prep_triprate(
     summarize_by = "age",
     variables_dt = variable_list,
+    remove_outliers = TRUE,
     hts_data = test_data
   )