Description
Usage
Arguments
Value
Examples
View source: R/grouped_lmer.R
Linear mixedeffects model (lmer
) across multiple grouping
variables.
 (
,
grouping.vars,
,
output = "tidy",
tidy.args = (conf.int = , conf.level = 0.95, = "fixed", conf.method =
"Wald"),
augment.args = ()
)

data 
Dataframe (or tibble) from which variables are to be taken.

grouping.vars 
Grouping variables.

... 
Arguments passed on to lme4::lmer
formula a twosided linear formula object describing both the
fixedeffects and randomeffects part of the model, with the
response on the left of a ~ operator and the terms, separated
by + operators, on the right. Randomeffects terms are
distinguished by vertical bars ( ) separating expressions
for design matrices from grouping factors. Two vertical bars
( ) can be used to specify multiple uncorrelated random
effects for the same grouping variable.
(Because of the way it is implemented, the  syntax works
only for design matrices containing numeric (continuous) predictors;
to fit models with independent categorical effects, see dummy
or the lmer_alt function from the afex package.)
REML logical scalar  Should the estimates be chosen to
optimize the REML criterion (as opposed to the loglikelihood)?
control a list (of correct class, resulting from
lmerControl() or glmerControl()
respectively) containing control parameters, including the nonlinear
optimizer to be used and parameters to be passed through to the
nonlinear optimizer, see the *lmerControl documentation for
details.
start a named list of starting values for the
parameters in the model. For lmer this can be a numeric
vector or a list with one component named "theta" .
verbose integer scalar. If > 0 verbose output is
generated during the optimization of the parameter estimates. If
> 1 verbose output is generated during the individual
penalized iteratively reweighted least squares (PIRLS) steps.
subset an optional expression indicating the subset of the rows
of data that should be used in the fit. This can be a logical
vector, or a numeric vector indicating which observation numbers are
to be included, or a character vector of the row names to be
included. All observations are included by default.
weights an optional vector of ‘prior weights’ to be used
in the fitting process. Should be NULL or a numeric vector.
Prior weights are not normalized or standardized in
any way. In particular, the diagonal of the residual covariance
matrix is the squared residual standard deviation parameter
sigma times the vector of inverse weights .
Therefore, if the weights have relatively large magnitudes,
then in order to compensate, the sigma parameter will
also need to have a relatively large magnitude.
na.action a function that indicates what should happen when the
data contain NA s. The default action (na.omit ,
inherited from the 'factory fresh' value of
getOption("na.action") ) strips any observations with any
missing values in any variables.
offset this can be used to specify an a priori known
component to be included in the linear predictor during
fitting. This should be NULL or a numeric vector of length
equal to the number of cases. One or more offset
terms can be included in the formula instead or as well, and if more
than one is specified their sum is used. See
model.offset .
contrasts an optional list. See the contrasts.arg of
model.matrix.default .
devFunOnly logical  return only the deviance evaluation
function. Note that because the deviance function operates on
variables stored in its environment, it may not return
exactly the same values on subsequent calls (but the results
should always be within machine tolerance).

output 
A character describing what output is expected. Two possible
options: "tidy" (default), which will return the results, or "glance" ,
which will return model summaries.

tidy.args 
A list of arguments to be used in the relevant S3 method.

augment.args 
A list of arguments to be used in the relevant S3 method.

A tibble dataframe with tidy results from a linear mixedeffects
model. Note that pvalue is computed using parameters::p_value
.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16  # for reproducibility
(123)
# loading libraries containing data
(gapminder)
# getting tidy output of results
# let's use only subset of the data
groupedstats::(
= gapminder,
= (lifeExp) ~ (gdpPercap) + (gdpPercap  continent),
grouping.vars = year,
REML = ,
tidy.args = ( = "fixed", conf.int = , conf.level = 0.95),
output = "tidy"
)

IndrajeetPatil/groupedstats documentation built on June 6, 2020, 9:57 a.m.