ds_entropy: Compute Entropy Index

Description Usage Arguments Value Examples

View source: R/entropy.R

Description

Compute Entropy Index

Usage

1
2
3
ds_entropy(.data, .cols, .name, .comp = FALSE)

entropy(..., .data = dplyr::cur_data_all())

Arguments

.data

tibble

.cols

tidy-select Columns to compute the measure with. Must be at least 2 columns. If more than 2, treats first column as first group and sum of other columns as second.

.name

name for column with entropy index. Leave missing to return a vector.

.comp

Default is FALSE. FALSE returns the sum, TRUE returns the components.

...

arguments to forward to ds_entropy from entropy

Value

a tibble or numeric vector if .name missing

Examples

1
2
3
data("de_county")
ds_entropy(de_county, c(pop_white, starts_with('pop_')))
ds_entropy(de_county, starts_with('pop_'), 'entropy')

divseg documentation built on Aug. 9, 2021, 9:09 a.m.