rcompanion (version 2.4.34)

groupwiseHuber: Groupwise Huber M-estimators and confidence intervals

Description

Calculates Huber M-estimator and confidence intervals for groups.

Usage

groupwiseHuber(
  formula = NULL,
  data = NULL,
  var = NULL,
  group = NULL,
  conf.level = 0.95,
  ci.type = "wald",
  digits = 3,
  ...
)

Value

A data frame of requested statistics by group.

Arguments

formula

A formula indicating the measurement variable and the grouping variables. e.g. y ~ x1 + x2.

data

The data frame to use.

var

The measurement variable to use. The name is in double quotes.

group

The grouping variable to use. The name is in double quotes. Multiple names are listed as a vector. (See example.)

conf.level

The confidence interval to use.

ci.type

The type of confidence interval to use. Can be "wald" or "boot". See HuberM for details.

digits

The number of significant figures to use in output.

...

Other arguments passed to the HuberM function.

Author

Salvatore Mangiafico,

Details

A wrapper for the DescTools::HuberM function to allow easy output for multiple groups.

The input should include either formula and data; or data, var, and group. (See examples).

Results for ungrouped (one-sample) data can be obtained by either setting the right side of the formula to 1, e.g. y ~ 1, or by setting group=NULL.

References

https://rcompanion.org/rcompanion/d_08a.html

See Also

groupwiseMean, groupwiseMedian, groupwiseGeometric

Examples

### Example with formula notation
data(Catbus)
groupwiseHuber(Steps ~ Teacher + Gender,
               data      = Catbus,
               ci.type   = "wald")
               
### Example with variable notation
data(Catbus)
groupwiseHuber(data      = Catbus,
               var       = "Steps",
               group     = c("Teacher", "Gender"),
               ci.type   = "wald")

### Example with NA value and without confidence intervals
data(Catbus)
Catbus1 = Catbus
Catbus1[1, 'Steps'] = NA
groupwiseHuber(Steps ~ Teacher + Gender,
               data      = Catbus1,
               conf.level   = NA)