multiplex_plot: Plot multiplex random effects in matrix form

View source: R/multiplex_plot.R

multiplex_plotR Documentation

Plot multiplex random effects in matrix form

Description

Plot multiplex random effects in matrix form

Usage

multiplex_plot(
  input,
  type = "dyadic",
  mode = "cor",
  HPDI = 0.9,
  plot = TRUE,
  export_as_table = FALSE,
  save_plot = NULL,
  height = 6,
  width = 6,
  palette = NULL
)

Arguments

input

A STRAND model object, obtained by fitting a multiplex combined stochastic block and social relations model.

type

Plot dyadic reciprocity ("dyadic") or generalized reciprocity ("generalized")?.

mode

For dyadic plots, should the dyadic correlation "cor" be plotted, or the dyadic covariance "cov", or the adjusted dyadic+error correlation "adj".

HPDI

Highest Posterior Density Interval. Ranges in (0,1).

plot

Should a plot be displayed?

export_as_table

Should the tabular data rather than a ggplot object be returned?

save_plot

Should a plot be exported to working directory? If so, set save_plot="desired_filename.pdf".

height

Height of exported plot.

width

Width of exported plot.

palette

Override the default palette with a 3-vector of color codes.

Value

A figure or tabluar data to make a figure.

Examples

## Not run: 
res = multiplex_plot(input = fit)

## End(Not run)


ctross/STRAND documentation built on Dec. 15, 2024, 6:02 a.m.