plot.ergmito: Function to visualize the optimization surface

View source: R/ergmito_surface.R

plot.ergmitoR Documentation

Function to visualize the optimization surface

Description

General diagnostics function. This function allows to visualize the surface to be maximize at around a particular point.

Usage

## S3 method for class 'ergmito'
plot(
  x,
  y = NULL,
  domain = NULL,
  plot. = TRUE,
  par_args = list(),
  image_args = list(),
  breaks = 20L,
  extension = 4L,
  params_labs = stats::setNames(names(coef(x)), names(coef(x))),
  ...
)

Arguments

x

An object of class ergmito.

y, ...

Ignored.

domain

A list.

plot.

Logical. When TRUE (default), the function will call graphics::image and plot all possible combination of parameters.

par_args

Further arguments to be passed to graphics::par

image_args

Further arguments to be passed to graphics::image

breaks

Integer scalar. Number of splits per dimension.

extension

Numeric. Range value of the function.

params_labs

Named vector. Alternative labels for the parameters. It should be in the form of c("orignial name" = "new name").

Details

It calculates the surface coordinates for each pair of parameters included in the ERGMito.

Value

A list of length choose(length(object$coef), 2) (all possible combinations of pairs of parameters), each with the following elements:

  • z A matrix

  • z A vector

  • y A vector

  • xlab A string. Name of the ERGM parameter in the x-axis.

  • ylab A string. Name of the ERGM parameter in the y-axis.

The list is returned invisible.

See Also

The ergmito function.

Examples


set.seed(12)
x <- rbernoulli(c(4, 4, 5))

ans <- ergmito(x ~ edges + balance)

plot(ans)


ergmito documentation built on July 9, 2023, 7:09 p.m.