gini_index: Gini Index

In yelleKneK/SMSD: Sequential Methods for Study Design

Gini Index

Description

This function calculates the Gini Index for a vector x.

Usage

gini_index(x, na.rm = TRUE)

Arguments

x	A vector containing the data for which the Gini index will be calculated.
na.rm	This parameter controls whether NA values are removed from the vector (or not). Default is TRUE.

Value

The calculated value of the Gini index.

Examples

# Household money from income brackets (2010) from Table C of
# https://en.wikipedia.org/wiki/Gini_coefficient. 
x <- c(13.7, 12.0, 10.9, 13.9, 17.7, 11.4, 12.1, 4.5, 3.9) 
gini_index(x)

yelleKneK/SMSD documentation built on Nov. 23, 2022, 6:40 p.m.