2.10.14 plot_network


Menu Information

Plot: Categorical: Network

Brief Information

Create a Network Plot

Command Line Usage

plot_network -r 2 dtype:=inc condition:=between condition_value1:=2 weighted:=1 node_row:=label col_label:="Long Name" node_col:=custom colrng:=[Book1]Sheet1!1 method:=kk;

X-Function Execution Options

Please refer to the page for additional option switches when accessing the x-function from script

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
Data Type dtype

Input

int

0

Specify the data type to plot a network plot.

Option List:

  • 0=adj:Adjacency matrix
    An adjacency matrix is a square matrix used to represent a finite graph. The elements of the matrix indicate whether pairs of vertices are adjacent or not in the graph.
  • 1=inc:Incidence matrix
    An incidence matrix is a logical matrix that shows the relationship between two classes of objects, usually called an incidence relation.
  • 2=edge:Edge list
    An edge list is a data structure used to represent a graph as a list of its edges.
Input irng

Input

Range

<active>

Specify the input data.

Include Diagonal of Matrix diag

Input

int

0

Specify whether include the self-feedback connecting information stored in the diagonal of the matrix. This option is only available for input Data Type is Adjacency Matrix (dtype=adj).

Option List:

  • 0=false
  • 1=true
Value Condition condition

Input

int

0

Set a filter for the matrix values to plot the links between the nodes. Only the values matching to the condition will be plotted as links.

Option List:

  • 0=all:All
  • 1=between:Between
  • 2=notbetween:Not Between
  • 3=gt:Greater than
  • 4=ge:Greater than or equal to
  • 5=lt:Less than
  • 6=le:Less than or equal to

Note:

When condition=all, condition_value1 and condition_value2 are not set.
When condition=between or condition=notbetween, you can set condition_value1 and condition_value2 to From and To value.
When condition=gtcondition=gecondition=lt or condition=le, you can set the condition_value1 to the value.
From / Value condition_value1

Input

double

0
  • When condition=between or condition=notbetween, you can specify the From value.
  • When condition=gtcondition=gecondition=lt or condition=le, you can specify the value.
To condition_value2

Input

double

0
  • When condition=between or condition=notbetween, you can specify the To value.
Weighted weighted

Input

int

0

Specify whether add weighting on the links between the nodes.
When specify weighted=1, the values for the links will be used to calculate a distance matrix which is used to define the XY location of the nodes.

Option List:

  • 0=false
  • 1=true
Directed directed

Input

int

0

Specify whether using an arrow to show the direction of each link.
When specify directed=1, you can decide the Direction is From Row to Column or From Column to Row.

Option List:

  • 0=false
  • 1=true'
Matrix Value Mode matrix_mode

Input

int

3

Specify how to pick the plot value between two nodes, without considering the link direction.
This option is only available for Data Type is Adjacency Matrix (dtype=adj), but not available when directed=1.

Option List:

  • 0=upper:Upper
    Only plot the values in the upper right triangle of the matrix, including the value at the diagonal.
  • 1=lower:Lower
    Only plot the values in the lower left triangle of the matrix, including the value at the diagonal.
  • 2=min:Min
    For the values between two nodes, only plot the minimum. If you have a square matrix A, plot the value min(A(i,j),A(j,i)) as the link for Node i and Node j.
  • 3=max:Max
    For the values between two nodes, only plot the maximum. If you have a square matrix A, plot the value max(A(i,j),A(j,i)) as the link between Node i and Node j.
  • 4=plus:Plus
    For the values between two nodes, plot the sum. If you have a square matrix A, plot the value A(i,j) + A(j,i) as the link between Node i and Node j.
Direction direction

Input

int

0

When directed=1, you can specify the Direction is From Row to Column or From Column to Row.

Option List:

  • 0=fromrow: From Row to Column
  • 1=fromcol: From Column to Row
Node Row node_row

Input

int

0

Specify the Node Row to define the node arrangement.

Option List:

  • 0=none:None
  • 1=selrow1:1st row in selection
  • 2=wksrow1:1st row in worksheet
  • 3=label: Column Label
Column Label col_label

Input

string

0

When Node Row is Column Label (node_row=label), specify the column label to Long Name, Units or Comments.

Option List:

  • L: Long Name
  • Units: Units
  • Comments: Comments
Node Column node_col

Input

int

0

Specify the Node Column to define the node arrangement.

Option List:

  • 0=none:None
  • 1=selcol1:1st column in selection
  • 2=wkscol1: 1st column in worksheet
  • 3=custom: Custom
Column Range colrng

Input

Range

<optional>

When Node Column is Custom (node_col=custom), set the Column Range by specified the column.

Method method

Input

int

3

Specify how to position the nodes.

Option List:

  • 0=fr:Fruchterman-Reingold
    Place nodes on the plane using the force-directed layout algorithm by Fruchterman and Reingold.
  • 1=kk:Kamada-Kawai
    Place nodes on the plane, or in the 3d space, based on a phyisical model of springs.
  • 2=mds:MDS
    Multidimensional scaling of some distance matrix defined on the nodes of a graph. When you select this layout, you can selectively set a matrix to define the distance between the nodes.
  • 3=stress:Stress
    Force-directed graph layout based on stress majorization.
  • 4=circle:Circle
    Place nodes on a circle, in the order of their vertex ids. This one is simple, just put each node to circle, order could be node column order
  • 5=pmds:Pivot MDS
    Similar to MDS but uses only a small set of pivots for MDS. Considerably faster than MDS and thus applicable for larger graphs.
  • 6=sparsestress:Sparse Stress
    Stress majorization for larger graphs based on a set of pivot nodes.
  • 7=fa2:ForceAtlas2
    ForceAtlas2 is a force-directed layout close to other algorithms used for network spatialization. ForceAtlas2 is a force directed layout: it simulates a physical system in order to spatialize a network. Nodes repulse each other like charged particles, while edges attract their nodes, like springs. These forces create a movement that converges to a balanced state. This final configuration is expected to help the interpretation of the data.
  • 8=custom:Custom
    Define the position of nodes by another XY range.
Distance Matrix method_param

Input

Range

<optional>

When Method is MDS or Pivot MDS, you can specify the Distance Matrix.

Description

This X-Function supports three type of input data to plot a network plot.

Please refer to Network Plot for more details.