File: gini.Rd

package info (click to toggle)
r-bioc-edger 3.40.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,484 kB
  • sloc: cpp: 1,425; ansic: 1,109; sh: 21; makefile: 5
file content (33 lines) | stat: -rw-r--r-- 867 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
\name{gini}
\alias{gini}
\title{Gini dispersion index}
\description{
Gini index for each column of a matrix.
}
\usage{
gini(x)
}
\arguments{
  \item{x}{a non-negative numeric matrix, or an object that can be coerced to such a matrix by \code{as.matrix}.}
}
\details{
The Gini coefficient or index is a measure of inequality or diversity.
It is zero if all the values of \code{x} are equal.
It reaches a maximum value of \code{1/nrow(x)} when all values are zero except for one.

The Gini index is only interpretable for non-negative quantities.
It is not meaningful if \code{x} contains negative values.
}
\value{
Numeric vector of length \code{ncol(x)}.
}
\references{
\url{https://en.wikipedia.org/wiki/Gini_coefficient}.
}
\examples{
x <- matrix(rpois(20,lambda=5),10,2)
gini(x)
}
\author{Gordon Smyth}

\concept{Data exploration}