R/fun_convert_algo_composite_to_igraph.R

In daviddoret/haricot: Algorithm Composition, Manipulation And Analysis

require(R6);
require(rlang);
require(igraph);

#' Convert an object of type algo_composite to an igraph object.
#'
#' @description The igraph network will be composed of:
#' * One node per input bit,
#' * One node per algorithm,
#' * One node per output bit,
#' * Directed edges from the input bits to the algorithm node,
#' * Directed edges from the algorithm node to the output bits,
#' * Directed edges between sub-algorithms.
#'
#' @examples g <- convert_algo_composite_to_igraph(node, ...);
#'
#' @param node The node that we want to graph (algo_composite)
#' @param ... For future usage.
#' @return A directed network graph representation of the node (igraph).
#' @export
convert_algo_composite_to_igraph <- function(node, ...){

  # algo_composite manage its internal state with an igraph...
  g <- node$get_dag();
  return(g);

}