✨ Initial commit for branch "dev_james_taeuber" (ndi v0.1.6.9005) (#21)

* Added `james_taeuber()` function to compute the aspatial racial or ethnic Dissimilarity Index (*D*) based on [James & Taeuber (1985)](https://doi.org/10.2307/270845)

Author: idblr

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: ndi
 Title: Neighborhood Deprivation Indices
-Version: 0.1.6.9004
-Date: 2024-08-23
+Version: 0.1.6.9005
+Date: 2024-08-24
 Authors@R:
     c(person(given = "Ian D.",
              family = "Buller",
@@ -46,10 +46,12 @@ Description: Computes various metrics of socio-economic deprivation and disparit
              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), (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>.
+             ISBN-13:978-1-032-53884-6) and Bell (1954) <doi:10.2307/2574118>, (13) the
+             aspatial racial or ethnic Gini Index (G) based Gini (1921) <doi:10.2307/2223319>, 
+             and (14) the aspatial racial or ethnic Dissimilarity Index (D) based on James & 
+             Taeuber (1985) <doi:10.2307/270845>. 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

NAMESPACE

@@ -8,6 +8,7 @@ export(bravo)
 export(duncan)
 export(gini)
 export(hoover)
+export(james_taeuber)
 export(krieger)
 export(lieberson)
 export(messer)

NEWS.md

@@ -1,11 +1,12 @@
 # ndi (development version)
 
-## ndi v0.1.6.9004
+## ndi v0.1.6.9005
 
 ### New Features
 * 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 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 `james_taeuber()` function to compute the aspatial racial or ethnic Dissimilarity Index (*D*) based on [James & Taeuber (1985)](https://doi.org/10.2307/270845)
 * 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`.
@@ -20,8 +21,8 @@
 * 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
+* Added examples for `gini()`, `james_taeuber()`, `lieberson()`, `hoover()` and `white_blau()` functions in vignette and README
+* Added example for `holder` argument in `atkinson()` function in README
 * Reformatted functions for consistent internal structure
 * Updated examples in vignette to showcase a larger variety of U.S. states
 * Updated examples in functions to better describe the metrics

R/duncan.R

@@ -67,7 +67,8 @@
 #' \dontrun{
 #' # Wrapped in \dontrun{} because these examples require a Census API key.
 #'
-#'   # Dissimilarity Index of non-Hispanic Black vs. non-Hispanic white populations
+#'   # Dissimilarity Index (Duncan & Duncan)
+#'   ## of non-Hispanic Black vs. non-Hispanic white populations
 #'   ## of census tracts within counties within Georgia, U.S.A., counties (2020)
 #'   duncan(
 #'     geo_large = 'county',
@@ -323,7 +324,7 @@ duncan <- function(geo_large = 'county',
     ## Compute
     out_tmp <- out_dat %>%
       split(., f = list(out_dat$oid)) %>%
-      lapply(., FUN = d_fun, omit_NAs = omit_NAs) %>%
+      lapply(., FUN = ddd_fun, omit_NAs = omit_NAs) %>%
       utils::stack(.) %>%
       dplyr::mutate(
         D = values,