AMR/man/kurtosis.Rd

35 lines
1.1 KiB
Plaintext
Raw Normal View History

2018-07-08 22:14:55 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/kurtosis.R
\name{kurtosis}
\alias{kurtosis}
\alias{kurtosis.default}
\alias{kurtosis.matrix}
\alias{kurtosis.data.frame}
\title{Kurtosis of the Sample}
2018-07-08 22:14:55 +02:00
\usage{
kurtosis(x, na.rm = FALSE, excess = FALSE)
2018-07-08 22:14:55 +02:00
\method{kurtosis}{default}(x, na.rm = FALSE, excess = FALSE)
2018-07-08 22:14:55 +02:00
\method{kurtosis}{matrix}(x, na.rm = FALSE, excess = FALSE)
2018-07-08 22:14:55 +02:00
\method{kurtosis}{data.frame}(x, na.rm = FALSE, excess = FALSE)
2018-07-08 22:14:55 +02:00
}
\arguments{
2020-10-08 11:16:03 +02:00
\item{x}{a vector of values, a \link{matrix} or a \link{data.frame}}
2018-07-08 22:14:55 +02:00
2021-05-12 18:15:03 +02:00
\item{na.rm}{a \link{logical} to indicate whether \code{NA} values should be stripped before the computation proceeds}
2021-05-12 18:15:03 +02:00
\item{excess}{a \link{logical} to indicate whether the \emph{excess kurtosis} should be returned, defined as the kurtosis minus 3.}
2018-07-08 22:14:55 +02:00
}
\description{
Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. A normal distribution has a kurtosis of 3 and a excess kurtosis of 0.
2018-07-08 22:14:55 +02:00
}
2022-08-21 16:37:20 +02:00
\examples{
kurtosis(rnorm(10000))
kurtosis(rnorm(10000), excess = TRUE)
2019-01-02 23:24:07 +01:00
}
2018-07-08 22:14:55 +02:00
\seealso{
\code{\link[=skewness]{skewness()}}
2018-07-08 22:14:55 +02:00
}