hsep propagation fix (#789)

* coming from formatters

* small fixes

* news

* adding more info

* newline fix

NEWS.md

@@ -19,6 +19,7 @@
  * Whitespace is not trimmed when rendering tables with `as_html`.
  * Started deprecation cycle for `col_fnotes_here` to be replaced with `col_footnotes`.
  * Exported `section_div` methods now have a dedicated documentation page that is visible to users.
+ * When tables are exported as `txt`, they preserve the horizontal separator of the table.
 
 ## rtables 0.6.5
 ### New Features

R/argument_conventions.R

@@ -53,7 +53,8 @@ NULL
 #' @param hsep character(1). Set of character(s) to be repeated as the separator
 #'   between the header and body of the table when rendered as text. Defaults to
 #'   a connected horizontal line (unicode 2014) in locals that use a UTF
-#'   charset, and to `-` elsewhere (with a once per session warning).
+#'   charset, and to `-` elsewhere (with a once per session warning). See 
+#'   [formatters::set_default_hsep()] for further information.
 #' @param indent_size numeric(1). Number of spaces to use per indent level.
 #'   Defaults to 2
 #' @param section_div character(1). String which should be repeated as a section

R/tt_toString.R

@@ -19,12 +19,9 @@ NULL
 
 #' Convert an `rtable` object to a string
 #'
+#' @inheritParams formatters::toString
 #' @inheritParams gen_args
 #' @inherit formatters::toString
-#' @param x table object
-#' @param widths widths of row.name and columns
-#' @param col_gap gap between columns
-#' @param hsep character to create line separator
 #' @exportMethod toString
 #'
 #' @return a string representation of \code{x} as it appears when printed.
@@ -340,6 +337,7 @@ setMethod(
       prov_footer = prov_footer(obj),
       table_inset = table_inset(obj),
       header_section_div = header_section_div(obj),
+      horizontal_sep = horizontal_sep(obj),
       indent_size = indent_size
     )
   }

tests/testthat/test-printing.R

@@ -739,3 +739,20 @@ test_that("Separators and wrapping work together with getter and setters", {
     "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
   )
 })
+
+test_that("horizontal separator is propagated from table to print and export", {
+  # GitHub error #778
+  lyt <- basic_table() %>%
+    split_cols_by("Species") %>%
+    analyze("Sepal.Length", afun = function(x) {
+      list(
+        "mean (sd)" = rcell(c(mean(x), sd(x)), format = "xx.xx (xx.xx)"),
+        "range" = diff(range(x))
+      )
+    })
+
+  tbl <- build_table(lyt, iris, hsep = "~")
+  tostring_tbl <- strsplit(toString(tbl), "\n")[[1]]
+  export_txt_tbl <- strsplit(export_as_txt(tbl), "\n")[[1]]
+  expect_identical(tostring_tbl, export_txt_tbl)
+})