get_emcontrasts {modelbased} | R Documentation |
Easy 'emmeans' and 'emtrends'
Description
The get_emmeans()
function is a wrapper to facilitate the usage of
emmeans::emmeans()
and emmeans::emtrends()
, providing a somewhat simpler
and intuitive API to find the specifications and variables of interest. It is
meanly made to for the developers to facilitate the organization and
debugging, and end-users should rather use the estimate_*()
series of
functions.
Usage
get_emcontrasts(
model,
contrast = NULL,
by = NULL,
fixed = NULL,
transform = "none",
method = "pairwise",
at = NULL,
...
)
model_emcontrasts(
model,
contrast = NULL,
by = NULL,
fixed = NULL,
transform = "none",
method = "pairwise",
at = NULL,
...
)
get_emmeans(
model,
by = "auto",
fixed = NULL,
transform = "response",
levels = NULL,
modulate = NULL,
at = NULL,
...
)
model_emmeans(
model,
by = "auto",
fixed = NULL,
transform = "response",
levels = NULL,
modulate = NULL,
at = NULL,
...
)
get_emtrends(
model,
trend = NULL,
by = NULL,
fixed = NULL,
levels = NULL,
modulate = NULL,
at = NULL,
...
)
model_emtrends(
model,
trend = NULL,
by = NULL,
fixed = NULL,
levels = NULL,
modulate = NULL,
at = NULL,
...
)
Arguments
model |
A statistical model. |
contrast |
A character vector indicating the name of the variable(s) for which to compute the contrasts. |
by |
The predictor variable(s) at which to evaluate the desired effect / mean / contrasts. Other predictors of the model that are not included here will be collapsed and "averaged" over (the effect will be estimated across them). |
fixed |
A character vector indicating the names of the predictors to be "fixed" (i.e., maintained), so that the estimation is made at these values. |
transform |
Is passed to the |
method |
Contrast method. See same argument in emmeans::contrast. |
at |
Deprecated, use |
... |
Other arguments passed for instance to |
levels , modulate |
Deprecated, use |
trend |
A character indicating the name of the variable for which to compute the slopes. |
Examples
if (require("emmeans", quietly = TRUE)) {
# Basic usage
model <- lm(Sepal.Width ~ Species, data = iris)
get_emcontrasts(model)
# Dealing with interactions
model <- lm(Sepal.Width ~ Species * Petal.Width, data = iris)
# By default: selects first factor
get_emcontrasts(model)
# Can also run contrasts between points of numeric
get_emcontrasts(model, contrast = "Petal.Width", length = 3)
# Or both
get_emcontrasts(model, contrast = c("Species", "Petal.Width"), length = 2)
# Or with custom specifications
estimate_contrasts(model, contrast = c("Species", "Petal.Width=c(1, 2)"))
# Can fixate the numeric at a specific value
get_emcontrasts(model, fixed = "Petal.Width")
# Or modulate it
get_emcontrasts(model, by = "Petal.Width", length = 4)
}
model <- lm(Sepal.Length ~ Species + Petal.Width, data = iris)
if (require("emmeans", quietly = TRUE)) {
# By default, 'by' is set to "Species"
get_emmeans(model)
# Overall mean (close to 'mean(iris$Sepal.Length)')
get_emmeans(model, by = NULL)
# One can estimate marginal means at several values of a 'modulate' variable
get_emmeans(model, by = "Petal.Width", length = 3)
# Interactions
model <- lm(Sepal.Width ~ Species * Petal.Length, data = iris)
get_emmeans(model)
get_emmeans(model, by = c("Species", "Petal.Length"), length = 2)
get_emmeans(model, by = c("Species", "Petal.Length = c(1, 3, 5)"), length = 2)
}
if (require("emmeans")) {
model <- lm(Sepal.Width ~ Species * Petal.Length, data = iris)
get_emtrends(model)
get_emtrends(model, by = "Species")
get_emtrends(model, by = "Petal.Length")
get_emtrends(model, by = c("Species", "Petal.Length"))
model <- lm(Petal.Length ~ poly(Sepal.Width, 4), data = iris)
get_emtrends(model)
get_emtrends(model, by = "Sepal.Width")
}