report (version 0.1.0)

report.lm: (General) Linear Models Report

Description

Create a report of a (general) linear model.

Usage

# S3 method for lm
report(
  model,
  interpretation = "default",
  ci = 0.95,
  standardize = "refit",
  standardize_robust = FALSE,
  bootstrap = FALSE,
  iterations = 500,
  performance_metrics = "all",
  ...
)

Arguments

model

Model object.

interpretation

Interpret the standardized parameters using a set of rules. Default corresponds to "funder2019" for linear models and "chen2010" for logistic models.

ci

Confidence Interval (CI) level. Default to 0.95 (95%).

standardize

The method used for standardizing the parameters. Can be "refit", "posthoc", "smart", "basic" or NULL (default) for no standardization. See 'Details' in standardize_parameters. Note that robust estimation (i.e. robust=TRUE) of standardized parameters only works when standardize="refit".

standardize_robust

Logical, if TRUE, robust standard errors are calculated (if possible), and confidence intervals and p-values are based on these robust standard errors.

bootstrap

Should estimates be based on bootstrapped model? If TRUE, then arguments of Bayesian regressions apply (see also bootstrap_parameters()).

iterations

The number of bootstrap replicates. This only apply in the case of bootstrapped frequentist models.

performance_metrics

See model_performance.

...

Arguments passed to or from other methods. For instance, when bootstrap = TRUE, arguments like ci_method are passed down to describe_posterior.

Value

A list-object of class report, which contains further list-objects with a short and long description of the model summary, as well as a short and long table of parameters and fit indices.

See Also

table_short or text_short to access the related content of the report-object.

Examples

# NOT RUN {
library(report)

model <- lm(Sepal.Length ~ Petal.Length * Species, data = iris)
r <- report(model)
text_short(r)
text_long(r)
table_short(r)
table_long(r)


model <- glm(vs ~ disp, data = mtcars, family = "binomial")
r <- report(model)
text_short(r)
text_long(r)
table_short(r)
table_long(r)
# }