`R/mutual.R`

`mutual_within.Rd`

Calculates the segregation between `group`

and `unit`

within each category defined by `within`

.

mutual_within(data, group, unit, within, weight = NULL, se = FALSE, n_bootstrap = 10, base = exp(1), wide = FALSE)

data | A data frame. |
---|---|

group | A categorical variable or a vector of variables
contained in |

unit | A categorical variable or a vector of variables
contained in |

within | A categorical variable or a vector of variables
contained in |

weight | Numeric. Only frequency weights are allowed.
(Default |

se | If |

n_bootstrap | Number of bootstrap iterations. (Default |

base | Base of the logarithm that is used in the calculation. Defaults to the natural logarithm. |

wide | Returns a wide dataframe instead of a long dataframe.
(Default |

Returns a data frame with four rows for each category defined by `within`

.
The column `est`

contains four statistics that
are provided for each unit:
`M`

is the within-category M, and `p`

is the proportion of the category.
Multiplying `M`

and `p`

gives the contribution of each within-category
towards the total M.
`H`

is the within-category H, and `h_weight`

provides the weight.
Multiplying `H`

and `h_weight`

gives the contribution of each within-category
towards the total H. `h_weight`

is defined as `p * EW/E`

, where `EW`

is the
within-category entropy, and `E`

is the overall entropy.
If `se`

is set to `TRUE`

, an additional column `se`

contains
the associated bootstrapped standard errors, and the column `est`

contains
bootstrapped estimates.
If `wide`

is set to `TRUE`

, returns instead a wide dataframe, with one
row for each `within`

category, and the associated statistics in separate columns.

Henri Theil. 1971. Principles of Econometrics. New York: Wiley.

Ricardo Mora and Javier Ruiz-Castillo. 2011. "Entropy-based Segregation Indices". Sociological Methodology 41(1): 159–194.

(within <- mutual_within(schools00, "race", "school", within = "state", weight = "n", wide = TRUE))#> state M p H h_weight #> 1 A 0.4085965 0.2768819 0.4969216 0.2240667 #> 2 B 0.2549959 0.4035425 0.2680884 0.3777638 #> 3 C 0.3450221 0.3195756 0.3611257 0.3004955# the M for "AL" is .409 # manual calculation schools_AL <- schools00[schools00$state=="AL",] mutual_total(schools_AL, "race", "school", weight = "n") # M => .409#> stat est #> M M 0 #> H H NaN# to recover the within M and H from the output, multiply # p * M and h_weight * H, respectively sum(within$p * within$M) # => .326#> [1] 0.3262953#> [1] 0.3211343#> stat est #> M M 0.3262953 #> H H 0.3211343