R/gf_scc.R

In graphframes: Interface for 'GraphFrames'

#' Strongly connected components
#'
#' Compute the strongly connected component (SCC) of each vertex and return a
#'   DataFrame with each vertex assigned to the SCC containing that vertex.
#'
#' @template roxlate-gf-x
#' @param max_iter Maximum number of iterations.
#' @template roxlate-gf-dots
#'
#' @examples
#' \dontrun{
#' g <- gf_friends(sc)
#' gf_scc(g, max_iter = 10)
#' }
#' @export
gf_scc <- function(x, max_iter, ...) {
  max_iter <- cast_scalar_integer(max_iter)

  gf <- spark_graphframe(x)

  algo <- gf %>%
    invoke("stronglyConnectedComponents") %>%
    invoke("maxIter", max_iter)

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