ginet.R

#' Generate a network description containing all hydraulic nodes and the description
#' of their connections
#'
#' @param db A tibble or a data frame containing at least columns with the id (column `id`), the id and the hydraulic distance to the node downstream (columns `down` and `length`) and a boolean determining whether the node is a rainfall run-off model or not (column `runoff`). The last downstream node should have fields `down` and `length` set to `NA`.
#' @param cols named list or vector for matching columns of `db` parameter. By default, mandatory columns names are: `id`, `down`, `length`. But other names can be handled with a named list or vector containing items defined as `"required name" = "column name in db"`.
#' @param keep_all Keep all column of `db` or keep only columns defined in `cols`
#'
#' @return `Ginet` class object containing the description of diagram of the semi-distributed catchment model
#' @export
Ginet <- function(db, cols = list(id = "id", down = "down", length = "length", runoff = "runoff"), keep_all = FALSE) {
  colsDefault <- list(id = "id", down = "down", length = "length", runoff = "runoff")
  cols <- utils::modifyList(colsDefault, as.list(cols))
  db <- dplyr::rename(db, unlist(cols))
  if(!keep_all) {
    db <- dplyr::select(db, names(cols))
  }
  class(db) <- append(class(db), c("Griwrm", "Ginet"))
  db
}

#' Sort the nodes from upstream to downstream.
#'
#' @param ginet See \code{[Ginet]}.
#'
#' @return vector with the ordered node names.
#' @export
getNodeRanking <- function(ginet) {
  if(!is(ginet, "Ginet")) {
    stop("getNodeRanking: ginet argument should be of class Ginet")
  }
  # Rank 1
  rank <- setdiff(ginet$id, ginet$down)
  ranking <- rank
  # Next ranks
  while(any(ginet$id %in% rank)) {
    rank <- ginet$down[ginet$id %in% rank]
    ranking <- c(ranking, rank)
  }
  ranking <- unique(ranking, fromLast = TRUE)
  ranking <- ranking[-length(ranking)]
}