interplot.plot: Plot Conditional Coefficients in Models with Interaction...
In interplot: Plot the Effects of Variables in Interaction Terms

Description Usage Arguments Details Value

View source: R/Interplot_plot.R

Graph based on the data frame of statistics about the conditional effect of an interaction.

## S3 method for class 'plot'
interplot(
  m,
  var1 = NULL,
  var2 = NULL,
  plot = TRUE,
  steps = NULL,
  ci = 0.95,
  adjCI = FALSE,
  hist = FALSE,
  var2_dt = NULL,
  predPro = FALSE,
  var2_vals = NULL,
  point = FALSE,
  sims = 5000,
  xmin = NA,
  xmax = NA,
  ercolor = NA,
  esize = 0.5,
  ralpha = 0.5,
  rfill = "grey70",
  stats_cp = "none",
  txt_caption = NULL,
  ci_diff = NULL,
  ks_diff = NULL,
  ...
)

`m`	A model object including an interaction term, or, alternately, a data frame recording conditional coefficients. This data frame should includes four columns: fake: The sequence of `var1` (the item whose effect will be conditioned on in the interaction); coef1: The point estimates of the coefficient of `var1` at each break point. ub: The upper bound of the simulated 95% CI. lb: The lower bound of the simulated 95% CI.
`var1`	The name (as a string) of the variable of interest in the interaction term; its conditional coefficient estimates will be plotted.
`var2`	The name (as a string) of the other variable in the interaction term.
`plot`	A logical value indicating whether the output is a plot or a dataframe including the conditional coefficient estimates of var1, their upper and lower bounds, and the corresponding values of var2.
`steps`	Desired length of the sequence. A non-negative number, which for seq and seq.int will be rounded up if fractional. The default is 100 or the unique categories in the `var2` (when it is less than 100. Also see `unique`).
`ci`	is a numeric value inherited from the data wrangling functions in this package. Adding it here is just for the method consistency.
`adjCI`	Succeeded from the data management functions in 'interplot' package.
`hist`	A logical value indicating if there is a histogram of 'var2' added at the bottom of the conditional effect plot.
`var2_dt`	A numerical value indicating the frequency distribution of 'var2'. It is only used when 'hist == TRUE'. When the object is a model, the default is the distribution of 'var2' of the model.
`predPro`	A logical value with default of 'FALSE'. When the 'm' is an output of a general linear model (class 'glm' or 'glmerMod') and the argument is set to 'TRUE', the function will plot predicted probabilities at the values given by 'var2_vals'.
`var2_vals`	A numerical value indicating the values the predicted probabilities are estimated, when 'predPro' is 'TRUE'.
`point`	A logical value determining the format of plot. By default, the function produces a line plot when var2 takes on ten or more distinct values and a point (dot-and-whisker) plot otherwise; option TRUE forces a point plot.
`sims`	Number of independent simulation draws used to calculate upper and lower bounds of coefficient estimates: lower values run faster; higher values produce smoother curves.
`xmin`	A numerical value indicating the minimum value shown of x shown in the graph. Rarely used.
`xmax`	A numerical value indicating the maximum value shown of x shown in the graph. Rarely used.
`ercolor`	A character value indicating the outline color of the whisker or ribbon.
`esize`	A numerical value indicating the size of the whisker or ribbon.
`ralpha`	A numerical value indicating the transparency of the ribbon.
`rfill`	A character value indicating the filling color of the ribbon.
`stats_cp`	A character value indicating what statistics to present as the plot note. Three options are available: "none", "ci", and "ks". The default is "none". See the Details for more information.
`txt_caption`	A character string to add a note for the plot, a value will sending to `ggplot2::labs(caption = txt_caption))`.
`ci_diff`	A numerical vector with a pair of values indicating the confidence intervals of the difference between `var1` and `var2`.
`ks_diff`	A `ks.test` object of the effect of `var1` conditioned on `var2`.
`...`	Other ggplot aesthetics arguments for points in the dot-whisker plot or lines in the line-ribbon plots. Not currently used.

interplot.plot is a S3 method from the interplot. It generates plots of conditional coefficients.

Because the output function is based on ggplot, any additional arguments and layers supported by ggplot2 can be added with the +.

interplot visualizes the conditional effect based on simulated marginal effects. The simulation provides a probabilistic distribution of moderation effect of the conditioning variable (var2) at every preset values (including the minimum and maximum values) of the conditioned variable (var1), denoted as Emin and Emax. This output allows the function to further examine the conditional effect statistically in two ways. One is to examine if the distribution of Emax - Emin covers zero. The other is to directly compare Emin and Emax through statistical tools for distributional comparisons. Users can choose either method by setting the argument stats_cp to "ci" or "ks".

"ci" provides the confidence interval of the difference of Emax - Emin. An interval including 0 suggests no statistical difference before and after the conditional effect is applied, and vise versa.
"ks" presents the result of a two-sample Kolmogorov-Smirnov test of the simulated distributions of Emin and Emax. The output includes a D statistics and a p-value of the null hypothesis that the two distributions come from the same distribution at the 0.05 level.

See an illustration in the package vignette.

The function returns a ggplot object.

interplot documentation built on Feb. 18, 2021, 9:06 a.m.