# typical_value: Return the typical value of a vector In sjstats: Collection of Convenient Functions for Common Statistical Computations

## Description

This function returns the "typical" value of a variable.

## Usage

 `1` ```typical_value(x, fun = "mean", weights = NULL, ...) ```

## Arguments

 `x` A variable. `fun` Character vector, naming the function to be applied to `x`. Currently, `"mean"`, `"weighted.mean"`, `"median"` and `"mode"` are supported, which call the corresponding R functions (except `"mode"`, which calls an internal function to compute the most common value). `"zero"` simply returns 0. Note: By default, if `x` is a factor, only `fun = "mode"` is applicable; for all other functions (including the default, `"mean"`) the reference level of `x` is returned. For character vectors, only the mode is returned. You can use a named vector to apply other different functions to numeric and categorical `x`, where factors are first converted to numeric vectors, e.g. `fun = c(numeric = "median", factor = "mean")`. See 'Examples'. `weights` Name of variable in `x` that indicated the vector of weights that will be applied to weight all observations. Default is `NULL`, so no weights are used. `...` Further arguments, passed down to `fun`.

## Details

By default, for numeric variables, `typical_value()` returns the mean value of `x` (unless changed with the `fun`-argument).

For factors, the reference level is returned or the most common value (if `fun = "mode"`), unless `fun` is a named vector. If `fun` is a named vector, specify the function for numeric and categorical variables as element names, e.g. `fun = c(numeric = "median", factor = "mean")`. In this case, factors are converted to numeric values (using `to_value`) and the related function is applied. You may abbreviate the names `fun = c(n = "median", f = "mean")`. See also 'Examples'.

For character vectors the most common value (mode) is returned.

## Value

The "typical" value of `x`.

## Examples

 ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21``` ```data(iris) typical_value(iris\$Sepal.Length) library(purrr) map(iris, ~ typical_value(.x)) # example from ?stats::weighted.mean wt <- c(5, 5, 4, 1) / 15 x <- c(3.7, 3.3, 3.5, 2.8) typical_value(x, fun = "weighted.mean") typical_value(x, fun = "weighted.mean", weights = wt) # for factors, return either reference level or mode value set.seed(123) x <- sample(iris\$Species, size = 30, replace = TRUE) typical_value(x) typical_value(x, fun = "mode") # for factors, use a named vector to apply other functions than "mode" map(iris, ~ typical_value(.x, fun = c(n = "median", f = "mean"))) ```

sjstats documentation built on Nov. 15, 2018, 5:04 p.m.