R/info_spectra.R

In allgebrist/algodyn: Algorithmic Information Dynamics

#' Compute the information spectra
#'
#' @param x an igraph object
#' @param what graph elements to be removed (i.e. edges or vertices)
#' @param block_size block size required to estimate the Kolmogorov-Chaitin complexity of \code{x} using the 2-dimensional Block Decomposition Method (BDM)
#' @param offset offset required to estimate the Kolmogorov-Chaitin complexity of \code{x} using the 2-dimensional Block Decomposition Method (BDM)
#'
#' @details The information spectra gives the list of information values for the edges or vertices of a graph.
#'
#' @import igraph
#' @return A data frame corresponding to the information spectra of the input graph.
#'
#' @examples
#' \dontrun{
#' frank <- make_graph("Franklin")
#' info_spectra(frank, what = 'vertices')
#' }
#'
#' @export
info_spectra <- function(x, what, block_size = 4, offset = 4) {

    spectra <- c()

    if (missing(what) || what == 'edges') {
        edge_deletions_df <- calculate_info_edges(x, block_size, offset)
        spectra <- edge_deletions_df
    } else if (what == 'vertices') {
        vertex_deletions_df <- calculate_info_vertices(x, block_size, offset)
        spectra <- vertex_deletions_df
    } else {
        stop("ERROR: A valid 'what' parameter should be given (edges or vertices).")
    }

    return(spectra)
}