stat_lorenz.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stat_lorenz.R
\name{stat_lorenz}
\alias{stat_lorenz}
\title{Values of Ordinary Lorenz Curve}
\usage{
stat_lorenz(
  mapping = NULL,
  data = NULL,
  geom = "path",
  position = "identity",
  ...,
  desc = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)
}
\arguments{
\item{mapping}{Set of aesthetic mappings created by \code{\link[ggplot2:aes]{aes()}} or
\code{\link[ggplot2:aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the
default), it is combined with the default mapping at the top level of the
plot. You must supply \code{mapping} if there is no plot mapping.}

\item{data}{The data to be displayed in this layer. There are three
options:

If \code{NULL}, the default, the data is inherited from the plot
data as specified in the call to \code{\link[ggplot2:ggplot]{ggplot()}}.

A \code{data.frame}, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
\code{\link[ggplot2:fortify]{fortify()}} for which variables will be created.

A \code{function} will be called with a single argument,
the plot data. The return value must be a \code{data.frame}, and
will be used as the layer data. A \code{function} can be created
from a \code{formula} (e.g. \code{~ head(.x, 10)}).}

\item{geom}{which geom to use; defaults to "\code{path}".}

\item{position}{Position adjustment, either as a string, or the result of
a call to a position adjustment function.}

\item{...}{Other arguments passed on to \code{\link[ggplot2:layer]{layer()}}. These are
often aesthetics, used to set an aesthetic to a fixed value, like
\code{colour = "red"} or \code{size = 3}. They may also be parameters
to the paired geom/stat.}

\item{desc}{If FALSE, the default, the population is arranged in ascending
order along the x-axis. If TRUE, the population is arranged in descending
order.}

\item{show.legend}{logical. Should this layer be included in the legends?
\code{NA}, the default, includes if any aesthetics are mapped.
\code{FALSE} never includes, and \code{TRUE} always includes.
It can also be a named logical vector to finely select the aesthetics to
display.}

\item{inherit.aes}{If \code{FALSE}, overrides the default aesthetics,
rather than combining with them. This is most useful for helper functions
that define both data and aesthetics and shouldn't inherit behaviour from
the default plot specification, e.g. \code{\link[ggplot2:borders]{borders()}}.}
}
\description{
Provides ordinary Lorenz curve values for line plots
}
\section{Aesthetics}{

\code{stat_lorenz()} understands the following aesthetics:
\itemize{
\item x (required: wealth of individual, or set of individuals if n aesthetic used)
\item n (optional: frequency of given observation x) }
}

\examples{
library(gglorenz)

ggplot(billionaires, aes(TNW)) +
    stat_lorenz()

ggplot(billionaires, aes(TNW)) +
    stat_lorenz(desc = TRUE) +
    coord_fixed() +
    geom_abline(linetype = "dashed") +
    theme_minimal()

\dontrun{
ggplot(freqdata, aes(x=value, n=freq)) +
    stat_lorenz() }

}
\references{
\href{https://en.wikipedia.org/wiki/Lorenz_curve}{Lorenz curve from Wikipedia}
}