Describe data

describe_data provides numerous descriptive estimators and bootstrap confidence intervals for variable x. describe_data function is a "wrapper" for bmbstats function.

describe_data(
  x,
  estimator_function = data_estimators,
  control = model_control(),
  na.rm = FALSE
)

Arguments

x	Numeric vector
estimator_function	Function that takes x and na.rm parameters and return named numeric vector with parameter estimates. Default is data_estimators. Other functions that could be used are data_estimators_simple and data_estimators_robust. User can write their own function with needed estimators for which bootstrap confidence intervals are needed
control	Control object returned from model_control function. Use boot_type, boot_samples, boot_strata to setup bootstrap.
na.rm	Should NAs be removed? Default is FALSE

Examples

desc1 <- describe_data(
  iris$Sepal.Width,
  estimator_function = data_estimators_simple,
  control = model_control(confidence = 0.90, boot_samples = 1000)
)
#> Bootstraping: 1000 resamples
#> Calculating confidence intervals...
#> Done!

desc1
#> Bootstrap with 1000 resamples and 90% bca confidence intervals.
#> 
#>  estimator     value     lower     upper
#>       mean 3.0573333 3.0020000 3.1180000
#>         SD 0.4358663 0.3981697 0.4845345
plot(desc1)