diff --git a/DESCRIPTION b/DESCRIPTION index 6594530..ef522b3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: segregation Type: Package Title: Entropy-Based Segregation Indices -Version: 0.4.0.9000 +Version: 0.5.0 Authors@R: person("Benjamin", "Elbers", email = "be2239@columbia.edu", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5392-3448")) Description: Computes entropy-based segregation indices, as developed by @@ -11,7 +11,8 @@ Description: Computes entropy-based segregation indices, as developed by and Frankel and Volij (2011) , is a measure of segregation that is highly decomposable. The package provides tools to decompose the index by units and groups (local segregation), - and by within and between terms. + and by within and between terms. The package also provides a method to decompose + differences in segregation as described by Elbers (2021) Includes standard error estimation by bootstrapping. License: MIT + file LICENSE Imports: data.table diff --git a/NEWS.md b/NEWS.md index f627da2..218c907 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,10 +1,10 @@ -# segregation 0.4.0.9000 +# segregation 0.5.0 * dissimilarity: support for the index of dissimilarity * add CI argument for confidence intervals * mutual_within: report ent_ratio instead of h_weight * matrix_to_long: convert contingency tables into long form -* add vignette +* add introductory vignette # segregation 0.4.0 diff --git a/README.Rmd b/README.Rmd index dfc586b..ef19796 100644 --- a/README.Rmd +++ b/README.Rmd @@ -30,12 +30,12 @@ on the Mutual Information Index (M) and Theil's Information Index (H). The index Find more information in the [vignette](https://elbersb.github.io/segregation/articles/segregation.html) and the [documentation](https://elbersb.de/segregation). - calculate total, between, within, and local segregation -- decompose differences in total segregation over time +- decompose differences in total segregation over time (Elbers 2020) - estimate standard errors and confidence intervals via bootstrapping - every method returns a [tidy](https://vita.had.co.nz/papers/tidy-data.html) [data.table](https://rdatatable.gitlab.io/data.table/) for easy post-processing and plotting - it's fast, because it uses the [`data.table`](https://rdatatable.gitlab.io/data.table/) package internally -Most of the procedures implemented in this package are described in more detail [in this working paper](https://osf.io/preprints/socarxiv/ya7zs/). +Most of the procedures implemented in this package are described in more detail [in this SMR paper](https://journals.sagepub.com/doi/full/10.1177/0049124121986204) ([Preprint](https://osf.io/preprints/socarxiv/ya7zs/)). ## Usage @@ -120,7 +120,8 @@ Mora, R., & Ruiz-Castillo, J. (2003). Additively decomposable segregation indexe Deutsch, J., Flückiger, Y. & Silber, J. (2009). Analyzing Changes in Occupational Segregation: The Case of Switzerland (1970–2000), in: Yves Flückiger, Sean F. Reardon, Jacques Silber (eds.) Occupational and Residential Segregation (Research on Economic Inequality, Volume 17), 171–202. -Elbers, B. (2019). A Method for Studying Difference in Segregation Levels Across Time and Space. SocArXiv Working Paper. https://osf.io/preprints/socarxiv/ya7zs/ +Elbers, B. (2021). A Method for Studying Differences in Segregation Across Time and Space. +Sociological Methods & Research. https://doi.org/10.1177/0049124121986204 Theil, H. (1971). Principles of Econometrics. New York: Wiley. diff --git a/README.md b/README.md index dc853e6..33efd5c 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Find more information in the and the [documentation](https://elbersb.de/segregation). - calculate total, between, within, and local segregation -- decompose differences in total segregation over time +- decompose differences in total segregation over time (Elbers 2020) - estimate standard errors and confidence intervals via bootstrapping - every method returns a [tidy](https://vita.had.co.nz/papers/tidy-data.html) @@ -30,8 +30,9 @@ and the [documentation](https://elbersb.de/segregation). internally Most of the procedures implemented in this package are described in more -detail [in this working -paper](https://osf.io/preprints/socarxiv/ya7zs/). +detail [in this SMR +paper](https://journals.sagepub.com/doi/full/10.1177/0049124121986204) +([Preprint](https://osf.io/preprints/socarxiv/ya7zs/)). ## Usage @@ -164,9 +165,9 @@ Flückiger, Sean F. Reardon, Jacques Silber (eds.) Occupational and Residential Segregation (Research on Economic Inequality, Volume 17), 171–202. -Elbers, B. (2019). A Method for Studying Difference in Segregation -Levels Across Time and Space. SocArXiv Working Paper. - +Elbers, B. (2021). A Method for Studying Differences in Segregation +Across Time and Space. Sociological Methods & Research. + Theil, H. (1971). Principles of Econometrics. New York: Wiley. diff --git a/cran-comments.md b/cran-comments.md index d7c523b..5efd16e 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,4 +1,5 @@ -Resubmit, fix URL +This release is necessitated by an upcoming change in data.table that +breaks one of the tests of this package. ## Test environments diff --git a/vignettes/segregation.Rmd b/vignettes/segregation.Rmd index 5aa5328..7deffa5 100644 --- a/vignettes/segregation.Rmd +++ b/vignettes/segregation.Rmd @@ -237,7 +237,7 @@ For this school, the bootstrap distribution is skewed. If precise inference abou ## Decomposing differences in indices -The command `mutual_difference()` can be used to decompose differences in segregation, as described in Elbers (2019). The default, and recommended method, is to use `method = shapley` (or `method = shapley_detailed`). The other methods (`mrc`, `km`) exist mostly for testing purposes, and are not recommended. Details on the procedure and how to interpret the terms of the decomposition are found in Elbers (2019). +The command `mutual_difference()` can be used to decompose differences in segregation, as described in Elbers (2021). The default, and recommended method, is to use `method = shapley` (or `method = shapley_detailed`). The other methods (`mrc`, `km`) exist mostly for testing purposes, and are not recommended. Details on the procedure and how to interpret the terms of the decomposition are found in Elbers (2021). ```{r} mutual_difference(schools00, schools05, "race", "school", weight = "n") @@ -246,7 +246,8 @@ This method also supports inference by setting `se = TRUE`. ## References -Elbers, B. (2019). A Method for Studying Difference in Segregation Levels Across Time and Space. SocArXiv Working Paper. https://osf.io/preprints/socarxiv/ya7zs/ +Elbers, B. (2021). A Method for Studying Differences in Segregation Across Time and Space. +Sociological Methods & Research. https://doi.org/10.1177/0049124121986204 Mora, R., & Ruiz-Castillo, J. (2011). Entropy-based Segregation Indices. Sociological Methodology, 41(1), 159–194. https://doi.org/10.1111/j.1467-9531.2011.01237.x