create_section_txt.R

#' Export a section in importation SIC format
#'
#' @param section_name [character], name of the section
#' @param abscissa [numeric], abscissa of the section in the reach
#' @param section_type 1-length [character], type of the section: "T" for Trapezoidal, "A" for Abscissa/Elevation, "L" for Width/Elevation
#' @param profile [list] or [matrix], profile of the section (See details)
#' @param distance_majeur [logical] or [numeric], `FALSE` for a minor bed section
#' @param singular [logical] `TRUE` for a singular section, `FALSE` for a regular section
#'
#' @return [character], section description in SIC text import format.
#' @export
#' @import utils
#' @examples
#' # Trapezoidal section
#' create_section_txt("Trapeze", 0, "T", list(B = 2, S = 1.5, ZF = 100, ZB = 102))
create_section_txt <- function(section_name,
                               abscissa,
                               section_type,
                               profile,
                               distance_majeur = FALSE,
                               singular = FALSE) {

  if (section_type == "T") {
    if (!is.list(profile) || !all(c("B", "S", "ZF", "ZB") %in% names(profile))) {
      stop("With `section_type = \"T\", `profile` should be a list with the items B, S, ZF and ZB")
    }
    sic_profile <- c("0", paste(profile$B, profile$S, sep = "\t"), paste(profile$ZB, profile$ZF, sep = "\t"))
  } else if (section_type %in% c("A", "L")) {
    if (!is.matrix(profile) || ncol(profile) != 2) {
      stop("With `section_type = \"A\" or \"L\", `profile` should be a matrix with 2 columns")
    }
    sic_profile <- capture.output(write.table(profile, sep = "\t", quote = FALSE, col.names = FALSE, row.names = FALSE))
  } else {
    stop("section_type ", section_type, " not allowed. Possible choices are: A, L and T")
  }

  if (!(is.logical(distance_majeur) || is.numeric(distance_majeur)) || length(distance_majeur) != 1) {
    stop("`distance_majeur` should be a `logical` or a `numeric` of length 1")
  }
  bMajorBed <- !is.logical(distance_majeur)
  section_txt <- c(paste(section_name,
          abscissa,
          ifelse(bMajorBed, distance_majeur, ""),
          ifelse(bMajorBed, "1", "0"),
          paste0(section_type, ifelse(singular, "S", "")),
          sep = " $ "),
    sic_profile)
  class(section_txt) <- c("SectionTxt", class(section_txt))
  return(section_txt)
}