strwap() exists!

[bwiernik]

I just realized that strwrap() exists. It's super useful for wrapping long text lines to the width of the console. It has similar functionality as insight::format_message() but better handles text that needs to break across more than 2 lines. Shouldn't need to update insight::format_message() because we shouldn't write messages that are that long.

cc @strengejacke

[mattansb]

x <- "easystats is a collection of R packages, which aims to provide a unifying and consistent framework to tame, discipline, and harness the scary R statistics and their pesky models."

(x_wrap <- strwrap(x, width = 80, exdent = 2))
#> [1] "easystats is a collection of R packages, which aims to provide a unifying and" 
#> [2] "  consistent framework to tame, discipline, and harness the scary R statistics"
#> [3] "  and their pesky models."




cat(paste0(x_wrap, collapse = "\n"))
#> easystats is a collection of R packages, which aims to provide a unifying and
#>   consistent framework to tame, discipline, and harness the scary R statistics
#>   and their pesky models.

message(paste0(x_wrap, collapse = "\n"))
#> easystats is a collection of R packages, which aims to provide a unifying and
#>   consistent framework to tame, discipline, and harness the scary R statistics
#>   and their pesky models.

warning(paste0(x_wrap, collapse = "\n"), call. = FALSE)
#> Warning: easystats is a collection of R packages, which aims to provide a unifying and
#>   consistent framework to tame, discipline, and harness the scary R statistics
#>   and their pesky models.

stop(paste0(x_wrap, collapse = "\n"), call. = FALSE)
#> Error: easystats is a collection of R packages, which aims to provide a unifying and
#>   consistent framework to tame, discipline, and harness the scary R statistics
#>   and their pesky models.





x_wrap2 <- strwrap(x, width = 80, exdent = 2, 
                   prefix = "EASYSTATS> ")

cat(paste0(x_wrap2, collapse = "\n"))
#> EASYSTATS> easystats is a collection of R packages, which aims to provide a
#> EASYSTATS>   unifying and consistent framework to tame, discipline, and harness
#> EASYSTATS>   the scary R statistics and their pesky models.

^{Created on 2022-04-17 by the reprex package (v2.0.1)}

[strengejacke]

We could replace the internal wrap_message_line() with strwrap(). It's not really slower.

x <- "easystats is a collection of R packages, which aims to provide a unifying and consistent framework to tame, discipline, and harness the scary R statistics and their pesky models."

microbenchmark::microbenchmark(
  strwrap = paste(strwrap(x, exdent = 2, width = 70), collapse = "\n"),
  wrap_msg = insight:::.wrap_message_line(x, line_length = 70),
  times = 1000
)
#> Unit: microseconds
#>      expr     min      lq     mean   median      uq       max neval cld
#>   strwrap 215.501 240.651 327.5591 275.5010 373.451  5729.901  1000   a
#>  wrap_msg 185.902 206.001 320.1423 225.0015 314.302 50151.301  1000   a

^{Created on 2022-04-17 by the reprex package (v2.0.1)}

[strengejacke]

but better handles text that needs to break across more than 2 lines.

In which way?

[bwiernik]

Our function only splits the string once, so if the string is very long, a word at the end of the second line might be split mid-word

[strengejacke]

Do you have a reprex?

library(insight)
msg <- "R is free software and comes with ABSOLUTELYNOWARRANTY. You are welcome to redistribute_it_under certain conditions. Type 'license()' or 'licence()' for-distribution-details."
cat(format_message(msg, line_length = 11.35))
#> R is free
#>   software
#>   and comes
#>   with
#>   ABSOLUTELYNOWARRANTY.
#>   You are
#>   welcome to
#>   redistribute_it_under
#>   certain
#>   conditions.
#>   Type
#>   'license()'
#>   or
#>   'licence()'
#>   for-distribution-details.
cat(paste(strwrap(msg, width = 11.35, exdent = 2), collapse = "\n"))
#> R is free
#>   software
#>   and
#>   comes
#>   with
#>   ABSOLUTELYNOWARRANTY.
#>   You are
#>   welcome
#>   to
#>   redistribute_it_under
#>   certain
#>   conditions.
#>   Type
#>   'license()'
#>   or
#>   'licence()'
#>   for-distribution-details.

^{Created on 2022-04-18 by the reprex package (v2.0.1)}

[bwiernik]

library(report)
a <- cite_easystats("all")
insight::format_message(a$intext)

[strengejacke]

I still don't see the difference?

library(report)
a <- cite_easystats("all")

cat(insight::format_message(a$intext, line_length = 70))
#> Analyses were conducted using the _easystats_ collection of packages
#>   (Lüdecke et al., 2019/2022a; Lüdecke et al., 2019, 2019/2022b;
#>   Makowski et al., 2021/2022a; Makowski et al., 2019, 2019/2022b;
#>   Lüdecke et al., 2021a, 2019/2022c; Lüdecke et al., 2020, 2019/2022d;
#>   Ben-Shachar et al., 2020, 2019/2022%s; Makowski et al., 2020,
#>   2020/2022c; Makowski et al., 2020/2022d; Lüdecke et al., 2021b,
#>   2019/2022e; Makowski et al., 2021/2022e).

cat(paste(strwrap(a$intext, exdent = 2, width = 72), collapse = "\n"))
#> Analyses were conducted using the _easystats_ collection of packages
#>   (Lüdecke et al., 2019/2022a; Lüdecke et al., 2019, 2019/2022b;
#>   Makowski et al., 2021/2022a; Makowski et al., 2019, 2019/2022b;
#>   Lüdecke et al., 2021a, 2019/2022c; Lüdecke et al., 2020, 2019/2022d;
#>   Ben-Shachar et al., 2020, 2019/2022%s; Makowski et al., 2020,
#>   2020/2022c; Makowski et al., 2020/2022d; Lüdecke et al., 2021b,
#>   2019/2022e; Makowski et al., 2021/2022e).

^{Created on 2022-04-19 by the reprex package (v2.0.1)}

[bwiernik]

Ah, I think I was looking at the direct print() output rather than cat() output. Sorry.