Learn R Programming

R package emmeans: Estimated marginal means

Website

https://rvlenth.github.io/emmeans/

Features

Estimated marginal means (EMMs, also known as least-squares means in the context of traditional regression models) are derived by using a model to make predictions over a regular grid of predictor combinations (called a reference grid). These predictions may possibly be averaged (typically with equal weights) over one or more of the predictors. Such marginally-averaged predictions are useful for describing the results of fitting a model, particularly in presenting the effects of factors. The emmeans package can easily produce these results, as well as various graphs of them (interaction-style plots and side-by-side intervals).

  • Estimation and testing of pairwise comparisons of EMMs, and several other types of contrasts, are provided.

  • In rank-deficient models, the estimability of predictions is checked, to avoid outputting results that are not uniquely defined.

  • For models where continuous predictors interact with factors, the package's emtrends function works in terms of a reference grid of predicted slopes of trend lines for each factor combination.

  • Vignettes are provided on various aspects of EMMs and using the package. See the CRAN page.

  • We try to provide flexible (but pretty basic) graphics support for the emmGrid objects produced by the package. Also, support is provided for nested fixed effects.

  • Response transformations and link functions are supported via a type argument in many functions (e.g., type = "response" to back-transform results to the response scale). Also, a regrid() function is provided to reconstruct the object on any transformed scale that the user wishes.

  • Two-way support of the glht function in the multcomp package.

Model support

  • The package incorporates support for many types of models, including standard models fitted using lm, glm, and relatives, various mixed models, GEEs, survival models, count models, ordinal responses, zero-inflated models, and others. Provisions for some models include special modes for accessing different types of predictions; for example, with zero-inflated models, one may opt for the estimated response including zeros, just the linear predictor, or the zero model. For details, see vignette("models", package = "emmeans")

  • Various Bayesian models (carBayes, MCMCglmm, MCMCpack) are supported by way of creating a posterior sample of least-squares means or contrasts thereof, which may then be examined using tools such as in the coda package.

  • Package developers are encouraged to incorporate emmeans support for

their models by writing recover_data and emm_basis methods. See vignette("extending", package = "emmeans")

Versions and installation

  • CRAN The latest CRAN version may be found at https://CRAN.R-project.org/package=emmeans. Also at that site, formatted versions of this package's vignettes may be viewed.

  • GitHub To install the latest development version from GitHub, install the newest version of the remotes package. If you are a Windows user, you should also first download and install the latest version of Rtools. Then run

remotes::install_github("rvlenth/emmeans", dependencies = TRUE, build_vignettes = TRUE)

Omitting the build_vignettes argument can save some time if you don't want the vignettes. They can always be found for the latest CRAN version or -- perhaps more up-to-date -- the emmeans site.

Note:

For the latest release notes on this development version, see the NEWS file

"Tidiness" can be dangerous

I see more and more users who are in a terrible hurry to get results. They develop a "workflow" where they plan-out several steps at once and pipe them together. That's useful when you don't have to think about what happens in those steps; but when you're doing statistics, you should be thinking! Most functions in the emmeans package yield results that are accompanied by annotations such as transformations involved, P-value adjustments made, the families for those adjustments, etc. If you just pipe the results into some more code, you never see those annotations.

Please slow down! Look at the actual results from each emmeans package function without any post-processing -- None. That way, you'll see the annotated summaries. Statistics is pretty hard stuff. Don't make it harder by blindfolding yourself.

Supersession plan

The developer of emmeans continues to maintain and occasionally add new features. However, none of us is immortal; and neither is software. I have thought of trying to find a co-maintainer who could carry the ball once I am gone or lose interest, but the flip side of that is that the codebase is not getting less messy as time goes on -- why impose that on someone else? So my thought now is that if at some point, enough active R developers want the capabilities of emmeans but I am no longer in the picture, they should feel free to supersede it with some other package that does it better. All of the code is publicly available on GitHub, so just take what is useful and replace what is not.

Note: emmeans supersedes the package lsmeans. The latter is just a front end for emmeans, and in fact, the lsmeans() function itself is part of emmeans.

Copy Link

Version

Install

install.packages('emmeans')

Monthly Downloads

98,197

Version

1.10.4

License

GPL-2 | GPL-3

Maintainer

Last Published

August 21st, 2024

Functions in emmeans (1.10.4)

emm_options

Set or change emmeans options
fiber

Fiber data
emmip

Interaction-style plots for estimated marginal means
emmobj

Construct an emmGrid object from scratch
extending-emmeans

Support functions for model extensions
emmeans-package

Estimated marginal means (aka Least-squares means)
emtrends

Estimated marginal means of linear trends
emmeans

Estimated marginal means (Least-squares means)
feedlot

Feedlot data
contrast-methods

Contrast families
models

Models supported in emmeans
emm

Support for multcomp::glht
make.tran

Response-transformation extensions
mvcontrast

Multivariate contrasts
joint_tests

Compute joint tests of the terms in a model
hpd.summary

Summarize an emmGrid from a Bayesian model
neuralgia

Neuralgia data
mvregrid

Multivariate regridding
comb_facs

Manipulate factors in a reference grid
as.mcmc.emmGrid

Support for MCMC-based estimation
pigs

Effects of dietary protein on free plasma leucine concentration in pigs
plot.emmGrid

Plot an emmGrid or summary_emm object
pwpp

Pairwise P-value plot
nutrition

Nutrition data
oranges

Sales of oranges
regrid

Reconstruct a reference grid with a new transformation or simulations
rbind.emmGrid

Combine or subset emmGrid objects
ref_grid

Create a reference grid from a fitted model
pwpm

Pairwise P-value matrix (plus other statistics)
qdrg

Quick and dirty reference grid
lsmeans

Wrappers for alternative naming of EMMs
untidy

Dare to be un-"tidy"!
summary.emmGrid

Summaries, predictions, intervals, and tests for emmGrid objects
ubds

Unbalanced dataset
update.emmGrid

Update an emmGrid object
xtable.emmGrid

Using xtable for EMMs
as.list.emmGrid

Convert to and from emmGrid objects
MOats

Oats data in multivariate form
cld.emmGrid

Compact letter displays
emm_example

Run or list additional examples
emmGrid-class

The emmGrid class
str.emmGrid

Miscellaneous methods for emmGrid objects
emm_list

The emm_list class
auto.noise

Auto Pollution Filter Noise
eff_size

Calculate effect sizes and confidence bounds thereof
contrast

Contrasts and linear functions of EMMs