get_eta_directed: Compute edge-level distributions for directed networks with...

View source: R/joint_dist.R

get_eta_directedR Documentation

Compute edge-level distributions for directed networks with respect to desired assortativity level(s).

Description

Compute edge-level distributions for directed networks with respect to desired assortativity level(s).

Usage

get_eta_directed(
  edgelist,
  target.assortcoef = list(outout = NULL, outin = NULL, inout = NULL, inin = NULL),
  eta.obj = function(x) 0,
  which.range,
  control = cvxr_control()
)

Arguments

edgelist

A two-column matrix representing the directed edges of a network.

target.assortcoef

A list representing the predetermined value or range of assortativity coefficients.

eta.obj

A convex function of eta to be minimized when which.range is NULL. Defaults to 0.

which.range

Character, "outout", "outin", "inout" or "inin"s, represents the interested degree based assortativity coefficient.

control

A list of parameters passed to CVXR::solve() when solving for eta or computing the range of assortativity coefficient.

Value

Assortativity coefficients and joint distributions. If which.range is specified, the range of the interested coefficient and the corresponding joint distributions will be returned, provided the predetermined target.assortcoef is satisfied.


wdnet documentation built on May 29, 2024, 9:32 a.m.