R/family_functions_check.R

In emillykkejensen/familyR: Fast family functions for your graph data

#' @import data.table
family_functions_check <- function(graph_dt, is_family_data = FALSE, verbose = FALSE){

  if(is_family_data){

    if(!all(c("nodes", "edges") %in% names(graph_dt))) stop("You need to add a list of two data.tables called nodes and edges")

    if(!all(c("id", "level") %in% names(graph_dt$nodes))) stop("Nodes data.tables needs to have both id and level")

    graph_dt$edges <- family_functions_check(graph_dt$edges, is_family_data = FALSE, verbose = verbose)

  } else {

    if(!data.table::is.data.table(graph_dt)){
      graph_dt <- data.table::as.data.table(graph_dt)
      if(verbose) warning("I feel the need... The need for speed! Set graph_dt as data.table by default and we won't have to do it.")
    }

    if(any(!(c("from", "to") %in% names(graph_dt)))) stop("You nedd to include from and to in colnames")

    if(!("id" %in% names(graph_dt))) graph_dt[, id := .I]

    if(data.table::uniqueN(graph_dt, by = "id") != nrow(graph_dt)) stop("id needs to be unique")

  }

  return(graph_dt)

}