R/RcppExports.R

Defines functions calculate_subgraph_structure_rcpp

Documented in calculate_subgraph_structure_rcpp

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' Find all subgraphs in pairs for every subset of edges (c++ version)
#'
#' Given a dataframe of edges with strength between nodes this function returns
#' info on every subgraph state achieved by adding nodes in one-at-a-time in
#' descending order of strength.
#'
#' @param associations Dataframe of association between two ids with a strength
#' @param a_col,b_col Names of columns that store the id's for the association pair
#' @param w_col Name of the column storing the strength of association
#' @param return_subgraph_membership Should an integer matrix of the subgraph
#'   membership for all nodes at all step be returned? This can be useful for
#'   comparing consistency of structure across different networks etc. but
#'   comes at the cost of speed and memory usage. This will also cause the
#'   algorithm to terminate after all nodes are merged into a giant component.
#'   This is to avoid execcessive memory usage.
#' @export
calculate_subgraph_structure_rcpp <- function(associations, a_col = "a", b_col = "b", w_col = "w", return_subgraph_membership = FALSE) {
    .Call(`_associationsubgraphs_calculate_subgraph_structure_rcpp`, associations, a_col, b_col, w_col, return_subgraph_membership)
}
nstrayer/entropynet documentation built on Oct. 12, 2020, 2:20 a.m.