parameters (version 0.4.0)

describe_distribution: Describe a Distribution

Description

This function describes a distribution by a set of indices (e.g., measures of centrality, dispersion, range, skewness, kurtosis).

Usage

describe_distribution(
  x,
  centrality = "mean",
  dispersion = TRUE,
  range = TRUE,
  ...
)

Arguments

x

A numeric vector.

centrality

The point-estimates (centrality indices) to compute. Character (vector) or list with one or more of these options: "median", "mean", "MAP" or "all".

dispersion

Logical, if TRUE, computes indices of dispersion related to the estimate(s) (SD and MAD for mean and median, respectively).

range

Return the range (min and max).

...

Additional arguments to be passed to or from methods.

Value

Converted index.

Examples

# NOT RUN {
describe_distribution(rnorm(100))
# }