Description Usage Arguments Value Note Examples

View source: R/describe_distribution.R

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | ```
describe_distribution(x, ...)
## S3 method for class 'numeric'
describe_distribution(
x,
centrality = "mean",
dispersion = TRUE,
iqr = TRUE,
range = TRUE,
quartiles = FALSE,
ci = NULL,
iterations = 100,
threshold = 0.1,
verbose = TRUE,
...
)
## S3 method for class 'factor'
describe_distribution(x, dispersion = TRUE, range = TRUE, verbose = TRUE, ...)
## S3 method for class 'data.frame'
describe_distribution(
x,
centrality = "mean",
dispersion = TRUE,
iqr = TRUE,
range = TRUE,
quartiles = FALSE,
include_factors = FALSE,
ci = NULL,
iterations = 100,
threshold = 0.1,
verbose = TRUE,
...
)
``` |

`x` |
A numeric vector. |

`...` |
Additional arguments to be passed to or from methods. |

`centrality` |
The point-estimates (centrality indices) to compute. Character (vector) or list with one or more of these options: |

`dispersion` |
Logical, if |

`iqr` |
Logical, if |

`range` |
Return the range (min and max). |

`quartiles` |
Return the first and third quartiles (25th and 75pth percentiles). |

`ci` |
Confidence Interval (CI) level. Default is |

`iterations` |
The number of bootstrap replicates for computing confidence
intervals. Only applies when |

`threshold` |
For |

`verbose` |
Toggle warnings and messages. |

`include_factors` |
Logical, if |

A data frame with columns that describe the properties of the variables.

There is also a
`plot()`

-method
implemented in the
see-package.

1 2 3 4 5 | ```
describe_distribution(rnorm(100))
data(iris)
describe_distribution(iris)
describe_distribution(iris, include_factors = TRUE, quartiles = TRUE)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.