compute_atkinson: Compute Atkinson index.

In JosepER/lissyrtools: Tools for LISSY Jobs

Compute Atkinson index.

Description

\lifecycle

experimental Compute the Atkinson index with weights.

Usage

compute_atkinson(
  file,
  file_name,
  variable,
  epsilon,
  weight = NULL,
  na.rm = FALSE
)

Arguments

file	A LIS or LWS file.
file_name	The name of the LIS or LWS file.
variable	A string with the name of the variable for which Atkinson should be computed.
epsilon	A number with the inequality adversion parameter. Needs to be epsilon > 0.
weight	A string with the name of the variable in 'file' that should be used as sample weights.
na.rm	A boolean. Indicates if NAs should be ignored. Defaults to FALSE.

Value

A numeric vector with the gini index.

JosepER/lissyrtools documentation built on Jan. 26, 2025, 10:01 p.m.