fix: function crashes due to missing paginate argument

[Tazovsky]

Function crashes, because paginate is not argument of function.

Error:

Error in isFALSE(paginate) : object 'paginate' not found

[github-actions]

🎉 Thank you for your contribution! Before this PR can be accepted, we require that you read and agree to our Contributor License Agreement.
You can digitally sign the CLA by posting a comment on this Pull Request in the format shown below. This agreement will apply to this PR as well as all future contributions on this repository.

---

I have read the CLA Document and I hereby sign the CLA

---

_{You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.}

[shajoezhu]

hi @Tazovsky , can you share an example with us when you seeing the bug? Thanks!

[Tazovsky]

hi @Tazovsky , can you share an example with us when you seeing the bug? Thanks!

@shajoezhu thanks for quick response!

I can prepare code to reproduce, but please confirm it is really needed... because:

paginate variable there https://github.com/insightsengineering/formatters/blob/main/R/mpf_exporters.R#L414C17-L414C25 is used before declaration when (.is_list_of_tables_or_listings(x)) is true:

export_as_rtf <- function(x,
                          file = NULL,
                          colwidths = NULL,
                          page_type = "letter",
                          pg_width = page_dim(page_type)[if (landscape) 2 else 1],
                          pg_height = page_dim(page_type)[if (landscape) 1 else 2],
                          landscape = FALSE,
                          margins = c(bottom = .5, left = .75, top = .5, right = .75),
                          font_family = "Courier",
                          font_size = 8,
                          lineheight = 1,
                          fontspec = font_spec(font_family, font_size, lineheight),
                          ...) {
  # Processing lists of tables or listings
  if (.is_list_of_tables_or_listings(x)) {
    if (isFALSE(paginate)) {
      warning(
        "paginate is FALSE, but x is a list of tables or listings, ",
        "so paginate will automatically be updated to TRUE"
      )
    }
    paginate <- TRUE
  }

Please let me know if you still need minimal code to reproduce error ;)

[shajoezhu]

i see! thanks for bring this to our attention. export_as_rtf is not a function that we actively testing, improvement is definitely needed. please can you share an example, I dont use rtf output, so we dont have any good example to reproduce, and debug this. thanks

[Melkiades]

This fix seems a good one to me @Tazovsky. Thanks. I let @shajoezhu follow up ;)

[shajoezhu]

hi @Tazovsky , can you update the doc please