R/gf_triangle_count.R

In graphframes: Interface for 'GraphFrames'

#' Computes the number of triangles passing through each vertex.
#'
#' This algorithm ignores edge direction; i.e., all edges are treated
#'   as undirected. In a multigraph, duplicate edges will be counted only once.
#'
#' @template roxlate-gf-x
#' @template roxlate-gf-dots
#'
#' @examples
#' \dontrun{
#' g <- gf_friends(sc)
#' gf_triangle_count(g)
#' }
#' @export
gf_triangle_count <- function(x, ...) {
  gf <- spark_graphframe(x)

  algo <- gf %>%
    invoke("triangleCount")

  algo %>%
    invoke("run") %>%
    sdf_register()
}