mirror of
https://github.com/msberends/AMR.git
synced 2024-12-28 04:46:11 +01:00
40 lines
1.6 KiB
R
40 lines
1.6 KiB
R
% 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}
|
|
\usage{
|
|
kurtosis(x, na.rm = FALSE)
|
|
|
|
\method{kurtosis}{default}(x, na.rm = FALSE)
|
|
|
|
\method{kurtosis}{matrix}(x, na.rm = FALSE)
|
|
|
|
\method{kurtosis}{data.frame}(x, na.rm = FALSE)
|
|
}
|
|
\arguments{
|
|
\item{x}{a vector of values, a \code{\link{matrix}} or a \code{\link{data.frame}}}
|
|
|
|
\item{na.rm}{a logical value indicating whether \code{NA} values should be stripped before the computation proceeds.}
|
|
}
|
|
\description{
|
|
Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable.
|
|
}
|
|
\section{Questioning lifecycle}{
|
|
|
|
\if{html}{\figure{lifecycle_questioning.svg}{options: style=margin-bottom:5px} \cr}
|
|
The \link[AMR:lifecycle]{lifecycle} of this function is \strong{questioning}. We are no longer convinced that this function is the optimal approach (but we do not know yet what a better approach would be), or whether this function should be in our \code{AMR} package at all.
|
|
}
|
|
|
|
\section{Read more on our website!}{
|
|
|
|
On our website \url{https://msberends.gitlab.io/AMR} you can find \href{https://msberends.gitlab.io/AMR/articles/AMR.html}{a comprehensive tutorial} about how to conduct AMR analysis, the \href{https://msberends.gitlab.io/AMR/reference}{complete documentation of all functions} (which reads a lot easier than here in R) and \href{https://msberends.gitlab.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}.
|
|
}
|
|
|
|
\seealso{
|
|
\code{\link[=skewness]{skewness()}}
|
|
}
|