cplot_extract: Generic extracts model information for use by 'cplot'

In vincentarelbundock/marginsplot: Plot (conditional) marginal effects using the 'margins' and 'ggplot2' packages

Description

Generic extracts model information for use by 'cplot'

Internal function to extract data for 'cplot'

Usage

## S3 method for class 'clm'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  at,
  n,
  type,
  xvals,
  vcov,
  what,
  zvar,
  zvals,
  ...
)

cplot_extract(object, ...)

## Default S3 method:
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  zvar,
  xvals,
  zvals,
  at,
  n,
  type,
  vcov,
  what,
  ...
)

## S3 method for class 'glm'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  zvar,
  xvals,
  zvals,
  at,
  n,
  type,
  vcov,
  what,
  ...
)

## S3 method for class 'lm'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  zvar,
  xvals,
  zvals,
  at,
  n,
  type,
  vcov,
  what,
  ...
)

## S3 method for class 'loess'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  zvar,
  xvals,
  zvals,
  at,
  n,
  type,
  vcov,
  what,
  ...
)

## S3 method for class 'polr'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  at,
  n,
  type,
  xvals,
  vcov,
  what = c("prediction", "classprediction", "stackedprediction", "effect"),
  zvar,
  zvals,
  ...
)

## S3 method for class 'multinom'
cplot_extract(
  object,
  data,
  dx,
  level,
  xvar,
  at,
  n,
  type,
  xvals,
  vcov,
  what = c("prediction", "classprediction", "stackedprediction", "effect"),
  zvar,
  zvals,
  ...
)

Arguments

object	A statistical model object
data	data.frame over which to calculate individual marginal effects or predictions
dx	The name of the variable whose effect should be plotted
level	The confidence level required (used to draw uncertainty bounds).
xvar	The name of the variable to show on the x-axis
at	Currently ignored.
n	An integer specifying the number of points across x at which to calculate the predicted value or marginal effect, when x is numeric. Ignored otherwise.
type	'response' or 'link'
xvals	A numeric vector of values at which to calculate predictions or marginal effects, if x is numeric. By default, it is calculated from the data using seq_range. If x is a factor, this is ignored, as is n.
vcov	the variance-covariance matrix used to calculate confidence intervals
what	The quantity to plot: 'prediction', 'effect', 'classprediction', or 'stackedprediction'
zvar	name of the third dimension variable over which quantities should be plotted (as facets).
zvals	discrete values of the z variable over which to plot
...	Additional arguments such as colour, linetype, size, shape, fill, alpha. These will be passed to ggplot2 geom functions to alter the style of the plot. If 'x' is a factor, these arguments will be passed to geom_pointrange. If 'x' is numeric, these arguments will be passed to geom_line and geom_ribbon. The alpha and fill arguments are not passed to geom_line. The colour argument is not passed to geom_ribbon.

vincentarelbundock/marginsplot documentation built on May 30, 2020, 12:07 a.m.