JointNets (version 2.0.1)

returngraph.simule: return igraph object from simule result specified by user input

Description

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

Usage

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

Arguments

x

output generated from simule function (simule class)

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

Value

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

Details

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

Examples

# NOT RUN {
library(JointNets)
data(exampleData)
result = simule(X = exampleData , lambda = 0.1, epsilon = 0.45, covType = "cov", FALSE)
graph = returngraph(result)
# }