returngraph.simulation: return igraph object from simulation result specified by user...

In JointNets: End-to-End Sparse Gaussian Graphical Model Simulation, Estimation, Visualization, Evaluation and Application

Description

This function can return an igraph object from simulation result for user to work with directly

Usage

## S3 method for class 'simulation'
returngraph(x, type = "task",
  neighbouroption = "task", subID = NULL, index = NULL, ...)

Arguments

x	output generated from simulatino functino
type	type of graph. There are four options: "task" (graph for each task (including shared part) specified further by subID (task number)) "share" (shared graph for all tasks) "taskspecific" (graph for each task specific graph (excluding shared part) specified further by subID (task number) ) "neighbour" (zoom into nodes in the graph specified further by neighbouroptoin, subID (task number) and index (node id))
neighbouroption	determines what type of graph to zoom into when parameter "type" is "neighbour". There are two options: "task" (zoom into graph for each task (including shared part)) "taskspecific" (zoom into graph for each task specific (excluding shared part))
subID	selects which task to display. There are four options: 0 (only allowed when "type" is "task" or "type" is "neighbour" and "neighbouroption" is "task") (selects share graph) positive task number (selects that particular task) a vector of task number (selects multiple tasks) NULL (selects all tasks (all graphs))
index	determines which node(s) to zoom into when parameter "type" is "neighbour". This parameter could either be an integer or vector of integers representing node ids (zoom into one node or multiple nodes)
...	not used

Details

the function aims to provide users the flexibility to explore and visualize the graph on their own generated from simulation

Value

an igraph object of graph / subgraph from simulation result specified by user input

Author(s)

Beilun Wang, Zhaoyang Wang (Author), Zhaoyang Wang (maintainer) [e-mail]

Examples

library(JointNets)
data(exampleData)
result = simulation(n=c(100,100,100))$simulatedgraphs
graph = returngraph(result)

JointNets documentation built on July 30, 2019, 1:02 a.m.