Add med_ratio_met function

Damonamajor · jeancochrane · wrridgeway · web-flow · commit 2cdd8bc865d2 · 2025-02-24T12:41:03.000-06:00
* Add med_ratio_met

* Update to v4

* Update R/formulas.R

Co-authored-by: Jean Cochrane &lt;jeancochrane@users.noreply.github.com&gt;

* Remove returns

* Update artifacts

* Test median_met function

* update docs

* lintr

* typo

* Better Roxygen note

* update all github actions

* revert github changes

* remove cache from gitignore

* Checkout v4

* Update upload-pages-artifact version

* update vignette

* update median ratio in vignette

* Update R/formulas.R

Co-authored-by: Jean Cochrane &lt;jeancochrane@users.noreply.github.com&gt;

* Update docs

---------

Co-authored-by: Jean Cochrane &lt;jeancochrane@users.noreply.github.com&gt;
Co-authored-by: Sweaty Handshake &lt;william.ridgeway@cookcountyil.gov&gt;
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -22,7 +22,7 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup pandoc
         uses: r-lib/actions/setup-pandoc@v2
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup R
         uses: r-lib/actions/setup-r@v2
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup pandoc
         uses: r-lib/actions/setup-pandoc@v2
@@ -36,7 +36,7 @@ jobs:
         uses: actions/configure-pages@v3
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: 'docs'
 
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup R
         uses: r-lib/actions/setup-r@v2
@@ -41,7 +41,7 @@ jobs:
 
       - name: Upload test results
         if: failure()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage-test-failures
           path: ${{ runner.temp }}/package
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -19,7 +19,7 @@ Encoding: UTF-8
 LazyData: true
 Imports:
     stats
-RoxygenNote: 7.2.3
+RoxygenNote: 7.2.4
 Suggests:
     covr,
     devtools,
diff --git a/NAMESPACE b/NAMESPACE
@@ -7,6 +7,7 @@ export(cod_met)
 export(detect_chasing)
 export(is_outlier)
 export(ki)
+export(med_ratio_met)
 export(mki)
 export(mki_met)
 export(prb)
diff --git a/R/formulas.R b/R/formulas.R
@@ -119,15 +119,15 @@ calc_prb <- function(assessed, sale_price) {
   rhs <- log(((assessed / med_ratio) + sale_price) * 0.5) / log(2)
   prb_model <- stats::lm(formula = lhs ~ rhs)
 
-  return(prb_model)
+  prb_model
 }
 
 
 # nolint start
 #' Calculate Coefficient of Price-Related Bias (PRB)
 #'
 #' @description PRB is an index of vertical equity that quantifies the
-#'   relationship betweem ratios and assessed values as a percentage. In
+#'   relationship between ratios and assessed values as a percentage. In
 #'   concrete terms, a PRB of 0.02 indicates that, on average, ratios increase
 #'   by 2\% whenever assessed values increase by 100 percent.
 #'
@@ -193,7 +193,7 @@ calc_gini <- function(assessed, sale_price) {
 
   result <- list(gini_assessed = gini_assessed, gini_sale = gini_sale)
 
-  return(result)
+  result
 }
 
 
@@ -319,3 +319,17 @@ prb_met <- function(x) x >= -0.05 & x <= 0.05
 #' @inheritParams cod_met
 #' @export
 mki_met <- function(x) x >= 0.95 & x <= 1.05
+
+##### Median_ratio_met #####
+
+#' Check if Sales Ratio Meets IAAO Standards
+#'
+#' This function checks whether the input sales ratio falls within
+#' the IAAO standard range (0.9 to 1.1).
+#'
+#' @param x Numeric vector of sales ratios. The function does not calculate any
+#'   medians, and instead assumes that vector elements already represent
+#'   median ratios.
+#' @return Logical vector indicating whether each value meets the standard.
+#' @export
+med_ratio_met <- function(x) x >= 0.9 & x <= 1.1
diff --git a/R/utils.R b/R/utils.R
@@ -25,5 +25,5 @@ index_na <- function(...) {
   # Merge lists into single index where if one list has NA, idx value is TRUE
   idx <- as.logical(Reduce("+", lapply(list(...), is.na)))
 
-  return(idx)
+  idx
 }
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -60,6 +60,7 @@ reference:
   - boot_ci
   - detect_chasing
   - is_outlier
+  - med_ratio_met
 
 - title: Data
   desc: Sample data used for testing and demonstrations
diff --git a/man/med_ratio_met.Rd b/man/med_ratio_met.Rd
diff --git a/tests/testthat/test-formulas.R b/tests/testthat/test-formulas.R
@@ -223,3 +223,11 @@ test_that("incomplete data returns NAs unless removed", {
     tolerance = 0.003
   )
 })
+
+
+##### TEST Median Ratio #####
+context("test median_ratio_met function")
+
+test_that("standard met function", {
+  expect_true(med_ratio_met(median(ratio)))
+})
diff --git a/vignettes/example-ratio-study.Rmd b/vignettes/example-ratio-study.Rmd
@@ -23,7 +23,7 @@ In general, there are four important statistics produced in sales ratio studies,
 | **COD**                 | 5 - 15           | How often properties with the *same* sale price receive the same predicted market value. Lower CODs indicate more fairness between similarly priced properties.                            |
 | **PRD**                 | .98 - 1.03       | How often properties with *different* sale prices receive the proportionately different predicted market values. Lower PRDs indicate more fairness between low and high-priced properties. |
 | **PRB**                 | -.05 - .05       | PRB is a different approach to measuring fairness across homes with different sale prices.                                                                                                 |
-| **Median Ratio**        | .95 - 1.05      | The median ratio measures whether the most common ratios accurately reflect sale prices.                                                                                                    |
+| **Median Ratio**        | .9 - 1.1      | The median ratio measures whether the most common ratios accurately reflect sale prices.                                                                                                    |
 | MKI                     | .95 - 1.05        | Measures the difference in inequality between assessed valuations and sale prices.                                               |
 | Sales Chasing (E.4)     | $\le$ 5%         | Measures the degree to which the statistics above are *true* reflections of the quality of assessments.                          |
 
@@ -149,10 +149,10 @@ library(knitr)
 # values AND sales
 combined <- inner_join(
   assessments %>%
-    select(pin, tax_year, township_name, mailed_tot, certified_tot, board_tot),
+    select(pin, year, township_name, mailed_tot, certified_tot, board_tot),
   sales %>%
     select(pin, year, sale_price, is_multisale),
-  by = c("pin", "tax_year" = "year")
+  by = c("pin", "year" = "year")
 ) %>%
   filter(township_name %in% c("New Trier", "Palatine"))
 

Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,5 @@ index_na <- function(...) {`
`25`	`25`	`# Merge lists into single index where if one list has NA, idx value is TRUE`
`26`	`26`	`idx <- as.logical(Reduce("+", lapply(list(...), is.na)))`
`27`	`27`
`28`		`- return(idx)`
	`28`	`+ idx`
`29`	`29`	`}`