✨ Initial commit for branch "dev_gini" (ndi v0.1.6.9004) (#20)

* The `gini()` function now computes the aspatial racial or ethnic Gini Index (*G*) based on [Gini (1921)](https://doi.org/10.2307/2223319) as the main outcome. Arguments `geo_large`, `geo_small`, `subgroup`, and `omit_NAs` were added and argument `geo` was deprecated. The `gini()` function still retrieves the original output of the aspatial income Gini Index (*G*) at each smaller geography and is moved from the `g` output to `g_data` output. * Renamed 'race/ethnicity' or 'racial/ethnic' to 'race or ethnicity' or 'racial or ethnic' throughout documentation to use more modern, inclusive, and appropriate language
idblr · Aug 24, 2024 · 3ee8a49 · 3ee8a49
1 parent 6448163
commit 3ee8a49
Show file tree

Hide file tree

Showing 38 changed files with 1,692 additions and 999 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: ndi
 Title: Neighborhood Deprivation Indices
-Version: 0.1.6.9003
+Version: 0.1.6.9004
 Date: 2024-08-23
 Authors@R:
     c(person(given = "Ian D.",
@@ -30,25 +30,26 @@ Description: Computes various metrics of socio-economic deprivation and disparit
              (2021) <doi:10.3390/ijerph18179384>, (3) compute the aspatial Index of 
              Concentration at the Extremes (ICE) based on Feldman et al. (2015) 
              <doi:10.1136/jech-2015-205728> and Krieger et al. (2016) 
-             <doi:10.2105/AJPH.2015.302955>, (4) compute the aspatial racial/ethnic 
+             <doi:10.2105/AJPH.2015.302955>, (4) compute the aspatial racial or ethnic 
              Dissimilarity Index (D) based on Duncan & Duncan (1955) <doi:10.2307/2088328>, (5)
-             compute the aspatial income or racial/ethnic Atkinson Index (A) based on Atkinson 
-             (1970) <doi:10.1016/0022-0531(70)90039-6>, (6) aspatial racial/ethnic Interaction
+             compute the aspatial income or racial or ethnic Atkinson Index (A) based on Atkinson 
+             (1970) <doi:10.1016/0022-0531(70)90039-6>, (6) aspatial racial or ethnic Interaction
              Index (xPy*) based on Shevky & Williams (1949; ISBN-13:978-0-837-15637-8) and Bell
-             (1954) <doi:10.2307/2574118>, (7) aspatial racial/ethnic Correlation Ratio (V)
+             (1954) <doi:10.2307/2574118>, (7) aspatial racial or ethnic Correlation Ratio (V)
              based on Bell (1954) <doi:10.2307/2574118> and White (1986) <doi:10.2307/3644339>,
-             (8) aspatial racial/ethnic Location Quotient (LQ) based on Merton (1939) 
+             (8) aspatial racial or ethnic Location Quotient (LQ) based on Merton (1939) 
              <doi:10.2307/2084686> and Sudano et al. (2013) 
-             <doi:10.1016/j.healthplace.2012.09.015>, (9) aspatial racial/ethnic Local
+             <doi:10.1016/j.healthplace.2012.09.015>, (9) aspatial racial or ethnic Local
              Exposure and Isolation (LEx/Is) metric based on Bemanian & Beyer (2017) 
-             <doi:10.1158/1055-9965.EPI-16-0926>, (10) aspatial racial/ethnic Delta (DEL) 
+             <doi:10.1158/1055-9965.EPI-16-0926>, (10) aspatial racial or ethnic Delta (DEL) 
              based on Hoover (1941) <doi:10.1017/S0022050700052980> and Duncan et al. (1961; 
              LC:60007089), (11) an index of spatial proximity (SP) based on White (1986)
-             <doi:10.2307/3644339> and Blau (1977; ISBN-13:978-0-029-03660-0), and (12) the 
-             aspatial racial/ethnic Isolatoin Index (xPx*) based on Lieberson (1981; 
-             ISBN-13:978-1-032-53884-6) and Bell (1954) <doi:10.2307/2574118>. Also using data
-             from the ACS-5 (2005-2009 onward), the package can retrieve the aspatial Gini 
-             Index (G) based Gini (1921) <doi:10.2307/2223319>.
+             <doi:10.2307/3644339> and Blau (1977; ISBN-13:978-0-029-03660-0), (12) the 
+             aspatial racial or ethnic Isolatoin Index (xPx*) based on Lieberson (1981; 
+             ISBN-13:978-1-032-53884-6) and Bell (1954) <doi:10.2307/2574118>, and (13) the
+             aspatial racial or ethnic Gini Index (G) based Gini (1921) <doi:10.2307/2223319>.
+             Also using data from the ACS-5 (2005-2009 onward), the package can retrieve the 
+             aspatial income Gini Index (G) based on Gini (1921) <doi:10.2307/2223319>.
 License: Apache License (>= 2.0)
 Encoding: UTF-8
 LazyData: true

diff --git a/NEWS.md b/NEWS.md
@@ -1,14 +1,15 @@
 # ndi (development version)
 
-## ndi v0.1.6.9003
+## ndi v0.1.6.9004
 
 ### New Features
-* Added `hoover()` function to compute the aspatial racial/ethnic Delta (*DEL*) based on [Hoover (1941)](https://doi.org/10.1017/S0022050700052980) and Duncan et al. (1961; LC:60007089)
+* Added `hoover()` function to compute the aspatial racial or ethnic Delta (*DEL*) based on [Hoover (1941)](https://doi.org/10.1017/S0022050700052980) and Duncan et al. (1961; LC:60007089)
 * Added `white_blau()` function to compute an index of spatial proximity (*SP*) based on [White (1986)](https://doi.org/10.2307/3644339) and Blau (1977; ISBN-13:978-0-029-03660-0)
-* Added `lieberson()` function to compute he aspatial racial/ethnic Isolation Index (_xPx\*_) based on Lieberson (1981; ISBN-13:978-1-032-53884-6) and and [Bell (1954)](https://doi.org/10.2307/2574118)
+* Added `lieberson()` function to compute the aspatial racial or ethnic Isolation Index (_xPx\*_) based on Lieberson (1981; ISBN-13:978-1-032-53884-6) and and [Bell (1954)](https://doi.org/10.2307/2574118)
 * Added `geo_large = 'cbsa'` for Core Based Statistical Areas, `geo_large = 'csa'` for Combined Statistical Areas, and `geo_large = 'metro'` for Metropolitan Divisions as the larger geographical unit in `atkinson()`, `bell()`, `bemanian_beyer()`, `duncan()`, `hoover()`, `lieberson()`, `sudano()`, and `white()`, `white_blau()` functions.
 * Thank you for the feature suggestions, [Symielle Gaston](https://orcid.org/0000-0001-9495-1592)
 * Added `holder` argument to `atkinson()` function to toggle the computation with or without the Hölder mean. The function can now compute *A* without the Hölder mean. The default is `holder = FALSE`.
+* The `gini()` function now computes the aspatial racial or ethnic Gini Index (*G*) based on [Gini (1921)](https://doi.org/10.2307/2223319) as the main outcome. Arguments `geo_large`, `geo_small`, `subgroup`, and `omit_NAs` were added and argument `geo` was deprecated. The `gini()` function still retrieves the original output of the aspatial income Gini Index (*G*) at each smaller geography and is moved from the `g` output to `g_data` output.
 
 ### Updates
 * `bell()` function computes the Interaction Index (Bell) not the Isolation Index as previously documented. Updated documentation throughout
@@ -17,6 +18,7 @@
 * `tigris` and `units` are now Imports
 * 'package.R' deprecated. Replaced with 'ndi-package.R'
 * Re-formatted code and documentation throughout for consistent readability
+* Renamed 'race/ethnicity' or 'racial/ethnic' to 'race or ethnicity' or 'racial or ethnic' throughout documentation to use more modern, inclusive, and appropriate language
 * Updated documentation about value range of *V* (White) from `{0 to 1}` to `{-Inf to Inf}`
 * Add examples for `hoover()` and `white_blau()` functions in vignette and README
 * Add example for `holder` argument in `atkinson()` function in README
@@ -39,11 +41,11 @@
 ## ndi v0.1.4
 
 ### New Features
-* Added `atkinson()` function to compute the aspatial income or racial/ethnic Atkinson Index (*A*) based on [Atkinson (1970)](https://doi.org/10.1016/0022-0531(70)90039-6) for specified counties/tracts 2009 onward
-* Added `bell()` function to compute the aspatial racial/ethnic Interaction Index (_xPy\*_) based on Shevky & Williams (1949; ISBN-13:978-0837156378) and [Bell (1954)](https://doi.org/10.2307/2574118)
-* Added `white()` function to compute the aspatial racial/ethnic Correlation Ratio (*V*) based on [Bell (1954)](https://doi.org/10.2307/2574118) and [White (1986)](https://doi.org/10.2307/3644339)
-* Added `sudano()` function to compute the aspatial racial/ethnic Location Quotient (*LQ*) based on [Merton (1939)](https://doi.org/10.2307/2084686) and [Sudano et al. (2013)](https://doi.org/10.1016/j.healthplace.2012.09.015)
-* Added `bemanian_beyer()` function to compute the aspatial racial/ethnic Local Exposure and Isolation (*LEx/Is*) metric based on [Bemanian & Beyer (2017)](https://doi.org/10.1158/1055-9965.EPI-16-0926)
+* Added `atkinson()` function to compute the aspatial income or racial or ethnic Atkinson Index (*A*) based on [Atkinson (1970)](https://doi.org/10.1016/0022-0531(70)90039-6) for specified counties/tracts 2009 onward
+* Added `bell()` function to compute the aspatial racial or ethnic Interaction Index (_xPy\*_) based on Shevky & Williams (1949; ISBN-13:978-0837156378) and [Bell (1954)](https://doi.org/10.2307/2574118)
+* Added `white()` function to compute the aspatial racial or ethnic Correlation Ratio (*V*) based on [Bell (1954)](https://doi.org/10.2307/2574118) and [White (1986)](https://doi.org/10.2307/3644339)
+* Added `sudano()` function to compute the aspatial racial or ethnic Location Quotient (*LQ*) based on [Merton (1939)](https://doi.org/10.2307/2084686) and [Sudano et al. (2013)](https://doi.org/10.1016/j.healthplace.2012.09.015)
+* Added `bemanian_beyer()` function to compute the aspatial racial or ethnic Local Exposure and Isolation (*LEx/Is*) metric based on [Bemanian & Beyer (2017)](https://doi.org/10.1158/1055-9965.EPI-16-0926)
 
 ### Updates
 * `car` is now Imports

diff --git a/R/anthopolos.R b/R/anthopolos.R
@@ -4,13 +4,13 @@
 #'
 #' @param geo Character string specifying the geography of the data either census tracts \code{geo = 'tract'} (the default) or counties \code{geo = 'county'}.
 #' @param year Numeric. The year to compute the estimate. The default is 2020, and the years 2009 onward are currently available.
-#' @param subgroup Character string specifying the racial/ethnic subgroup(s). See Details for available choices.
+#' @param subgroup Character string specifying the racial or ethnic subgroup(s). See Details for available choices.
 #' @param quiet Logical. If TRUE, will display messages about potential missing census information. The default is FALSE.
 #' @param ... Arguments passed to \code{\link[tidycensus]{get_acs}} to select state, county, and other arguments for census characteristics
 #'
-#' @details This function will compute the spatial Racial Isolation Index (\emph{RI}) of U.S. census tracts or counties for a specified geographical extent (e.g., the entire U.S. or a single state) based on Anthopolos et al. (2011) \doi{10.1016/j.sste.2011.06.002} who originally designed the metric for the racial isolation of non-Hispanic Black individuals. This function provides the computation of \emph{RI} for any of the U.S. Census Bureau race/ethnicity subgroups (including Hispanic and non-Hispanic individuals).
+#' @details This function will compute the spatial Racial Isolation Index (\emph{RI}) of U.S. census tracts or counties for a specified geographical extent (e.g., the entire U.S. or a single state) based on Anthopolos et al. (2011) \doi{10.1016/j.sste.2011.06.002} who originally designed the metric for the racial isolation of non-Hispanic Black individuals. This function provides the computation of \emph{RI} for any of the U.S. Census Bureau race or ethnicity subgroups (including Hispanic and non-Hispanic individuals).
 #'
-#' The function uses the \code{\link[tidycensus]{get_acs}} function to obtain U.S. Census Bureau 5-year American Community Survey characteristics used for the geospatial computation. The yearly estimates are available for 2009 onward when ACS-5 data are available but are available from other U.S. Census Bureau surveys. The twenty racial/ethnic subgroups (U.S. Census Bureau definitions) are:
+#' The function uses the \code{\link[tidycensus]{get_acs}} function to obtain U.S. Census Bureau 5-year American Community Survey characteristics used for the geospatial computation. The yearly estimates are available for 2009 onward when ACS-5 data are available but are available from other U.S. Census Bureau surveys. The twenty racial or ethnic subgroups (U.S. Census Bureau definitions) are:
 #' \itemize{
 #'  \item \strong{B03002_002}: not Hispanic or Latino \code{'NHoL'}
 #'  \item \strong{B03002_003}: not Hispanic or Latino, white alone\code{'NHoLW'}
@@ -36,7 +36,7 @@
 #'
 #' Use the internal \code{state} and \code{county} arguments within the \code{\link[tidycensus]{get_acs}} function to specify geographic extent of the data output. NOTE: Current version does not correct for edge effects (e.g., census geographies along the specified spatial extent border, coastline, or U.S.-Mexico / U.S.-Canada border) may have few neighboring census geographies, and \emph{RI} values in these census geographies may be unstable. A stop-gap solution for the former source of edge effect is to compute the \emph{RI} for neighboring census geographies (i.e., the states bordering a study area of interest) and then use the estimates of the study area of interest.
 #'
-#' A census geography (and its neighbors) that has nearly all of its population who identify with the specified race/ethnicity subgroup(s) (e.g., non-Hispanic or Latino, Black or African American alone) will have an \emph{RI} value close to 1. In contrast, a census geography (and its neighbors) that has nearly none of its population who identify with the specified race/ethnicity subgroup(s) (e.g., not non-Hispanic or Latino, Black or African American alone) will have an \emph{RI} value close to 0.
+#' A census geography (and its neighbors) that has nearly all of its population who identify with the specified race or ethnicity subgroup(s) (e.g., non-Hispanic or Latino, Black or African American alone) will have an \emph{RI} value close to 1. In contrast, a census geography (and its neighbors) that has nearly none of its population who identify with the specified race or ethnicity subgroup(s) (e.g., not non-Hispanic or Latino, Black or African American alone) will have an \emph{RI} value close to 0.
 #'
 #' @return An object of class 'list'. This is a named list with the following components:
 #'
@@ -167,7 +167,7 @@ anthopolos <- function(geo = 'tract',
     ## RI_{im} = (Sigma_{j∈∂_{i}} w_{ij} * T_{jm}) / (Sigma_{j∈∂_{i}} w_{ij} * T_{j})
     ## Where:
     ## ∂_{i} denotes the set of index units i and its neighbors
-    ## Given M mutually exclusive racial/ethnic subgroups, m indexes the subgroups of M
+    ## Given M mutually exclusive racial or ethnic subgroups, m indexes the subgroups of M
     ## T_{i} denotes the total population in region i (TotalPop)
     ## T_{im} denotes the population of the selected subgroup(s) (subgroup1, ...)
     ## w_{ij} denotes a nXn first-order adjacency matrix, where n is the number of census geometries in the study area