check_expdist: Check if observed data can be modeled by the exponential...

View source: R/check_expdist.R

check_expdistR Documentation

Check if observed data can be modeled by the exponential distribution.

Description

The exponential distribution is the probability distribution of the time between events in a process in which events occur continuously and independently at a constant average rate. Its mean and standard deviation are equal to the inverse of the average rate. check_expdist takes in a data frame and returns a function for making ggplot2 type of CDF and CCDF (on log-y scale) plots side by side on one canvas of any continuous variable from the data frame. CCDF standands for Complement CDF. If CCDF on log-y scale is linear, the observed variable can be modeled by the exponential distribution with a rate equal to the absolute value of the slope.

Usage

check_expdist(df)

Arguments

df

A data frame.

Value

function(varname, linew = 0.7, xlab = varname, title_left, title_right, subtitle_left, subtitle_right, caption_left, caption_right, digits = 2, ...)

  • varname. String, name of a continuous variable. Its empirical CDF will be plotted along side its complement CDF.

  • linew. Number, width of the line. Default = 0.7.

  • xlab. String, x label of the left and the right figures. Default is varname.

  • title_left. String, title of the left figure.

  • title_right. String, title of the right figure.

  • subtitle_left. String, subtitle of the left figure.

  • subtitle_right. String, subtitle of the right figure.

  • caption_left. String, caption of the left figure.

  • caption_right. String, caption of the right figure.

  • digits. Integer, the number of digits after the decimal point for the estimated parameter values of the theoretical distribution. Default = 2.

  • .... Other parameters for making a CDF plot. A common one, for example, is 'add_vline_median = TRUE', which will add a vertical line at the median. Another common one is 'show_label_median = FALSE', which will suppress the display of median value along the median vline. See mk_cdfplot for a full list of parameters.

See Also

est_params_expdist for how the rate of the theoretical exponential distribution is estimated.

Examples

inst/examples/ex-check_expdist.R

gmlang/ezplot documentation built on Sept. 18, 2022, 6:33 a.m.