R/as-tbl-graph.R

Defines functions as_tbl_graph.cor_network as_tbl_graph.correlate as_tbl_graph.corr.test as_tbl_graph.rcorr as_tbl_graph.pro_tbl as_tbl_graph.mantel_tbl as_tbl_graph.cor_tbl

Documented in as_tbl_graph.cor_network as_tbl_graph.correlate as_tbl_graph.corr.test as_tbl_graph.cor_tbl as_tbl_graph.mantel_tbl as_tbl_graph.pro_tbl as_tbl_graph.rcorr

#' Corece to a graph_tbl object
#' @description Functions to coerce a object to graph_tbl if possible.
#' @param x \code{R} object.
#' @param directed 	logical value, whether or not to create a directed graph.
#' @param ... extra params.
#' @return tbl_graph object.
#' @importFrom tidygraph tbl_graph as_tbl_graph
#' @rdname as_tbl_graph
#' @author Houyun Huang, Lei Zhou, Jian Chen, Taiyun Wei
#' @export
as_tbl_graph.cor_tbl <- function(x, directed = FALSE, ...)
{
  x <- as_cor_network(x, ...)
  tidygraph::tbl_graph(nodes = x$nodes,
                       edges = x$edges, directed = directed)
}


#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.mantel_tbl <- function(x, directed = FALSE, ...)
{
  as_tbl_graph(as_cor_tbl(x), directed = directed, ...)
}

#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.pro_tbl <- function(x, directed = FALSE, ...)
{
  as_tbl_graph(as_cor_tbl(x), directed = directed, ...)
}

#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.rcorr <- function(x, directed = FALSE, ...)
{
  p.value <- x$P
  diag(p.value) <- 0
  cor_network(x$r, p.value, directed = directed, ..., val.type = "tbl_graph")
}

#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.corr.test <- function(x, directed = FALSE, ...)
{
  cor_network(x$r, x$p, directed = directed, ..., val.type = "tbl_graph")
}

#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.correlate <- function(x, directed = FALSE, ...)
{
  cor_network(x$r, x$p.value, directed = directed, ..., val.type = "tbl_graph")
}

#' @importFrom tidygraph tbl_graph
#' @rdname  as_tbl_graph
#' @export
as_tbl_graph.cor_network <- function(x, ...)
{
  directed <- attr(x, "directed")
  tidygraph::tbl_graph(nodes = x$nodes, edges = x$edges,
                       directed = directed %||% FALSE)
}
houyunhuang/ggcor documentation built on July 22, 2020, 8:31 p.m.