ggpmisc (version 0.3.1)

stat_fit_glance: One row summary data frame for a fitted model

Description

stat_fit_glance fits a model and returns a summary "glance" of the model's statistics, using package 'broom'.

Usage

stat_fit_glance(mapping = NULL, data = NULL, geom = "text_npc",
  method = "lm", method.args = list(formula = y ~ x),
  label.x = "left", label.y = "top", hstep = 0, vstep = NULL,
  position = "identity", na.rm = FALSE, show.legend = FALSE,
  inherit.aes = TRUE, ...)

Arguments

mapping

The aesthetic mapping, usually constructed with aes or aes_. Only needs to be set at the layer level if you are overriding the plot defaults.

data

A layer specific dataset - only needed if you want to override the plot defaults.

geom

The geometric object to use display the data

method

character.

method.args

list of arguments to pass to method.

label.x, label.y

numeric with range 0..1 "normalized parent coordinates" (npc units) or character if using geom_text_npc() or geom_label_npc(). If using geom_text() or geom_label() numeric in native data units. If too short they will be recycled.

hstep, vstep

numeric in npc units, the horizontal and vertical step used between labels for different groups.

position

The position adjustment to use for overlapping points on this layer

na.rm

a logical indicating whether NA values should be stripped before the computation proceeds.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes.

inherit.aes

If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders.

...

other arguments passed on to layer. This can include aesthetics whose values you want to set, not map. See layer for more details.

Computed variables

The output of glance is returned as is in the data object. If you do not know what names to expect for the variables returned, use broom::glance() and names() or print() to find out.

Warning!

The current implementation works only with methods that accept a formula as argument and which have a data paremeter through which a data frame can be passed. For example, lm() should be used with the formula interface, as the evaluation of x and y needs to be delayed until the internal object of the ggplot is available.

stat_fit_glance applies the function given by method separately to each group of observations, and factors mapped to aesthetics generate a separate group for each factor level. Because of this, it is not useful for annotating plots with results from t.test() or ANOVA or ANCOVA. In such cases use the stat_fit_tb() statistic which does the model fitting per panel.

Examples

# NOT RUN {
# Regression example
my.df <-
  data.frame(X = c(44.4, 45.9, 41.9, 53.3, 44.7, 44.1, 50.7, 45.2, 60.1),
             Y = c( 2.6,  3.1,  2.5,  5.0,  3.6,  4.0,  5.2,  2.8,  3.8))
# We need to check the names of the returned values!
broom::glance(lm(formula = Y ~ X, data = my.df ))
ggplot(my.df, aes(X, Y)) +
  geom_point() +
  stat_fit_glance(method = "lm",
                  method.args = list(formula = y ~ x),
                  aes(label = sprintf('r^2~"="~%.3f~~italic(P)~"="~%.2f',
                      stat(r.squared), stat(p.value))),
                  parse = TRUE)

# }