Upkeep

[dunkenwg]

No description provided.

[dunkenwg]

resolves poissonconsulting/infrastructure-issues#204

[dunkenwg]

One test in test-knit.R is failing with the following error: '\U' used without hex digits in character string (<text>:3:13).

I'm guessing this has to do with file path differences between operating systems. I think both mac and ubuntu accept \, but windows uses \\ (the first \ is an escape character for the second \). Should we skip this test on windows or remove the windows R-CMD-check?

[aylapear]

One test in test-knit.R is failing with the following error: '\U' used without hex digits in character string (<text>:3:13).

I'm guessing this has to do with file path differences between operating systems. I think both mac and ubuntu accept \, but windows uses \\ (the first \ is an escape character for the second \). Should we skip this test on windows or remove the windows R-CMD-check?

It would be good to dig into the error further before turning the test off and seeing if there is a change we can make to the code so it works on both windows and other systems. I think you should dig into the code and determine what exactly is causing the issue in windows and if anything can be done to fix it as it.

[dunkenwg]

I think the error is occurring because of this line in knit.R: utils::browseURL(paste0('file://', path)). I tried switching it to utils::browseURL(paste0('file:///', path)) to see if that would fix the problem in windows. It didn't... Do either of you have any suggestions for making the url file path work for windows?

[aylapear]

I think the error is occurring because of this line in knit.R: utils::browseURL(paste0('file://', path)). I tried switching it to utils::browseURL(paste0('file:///', path)) to see if that would fix the problem in windows. It didn't... Do either of you have any suggestions for making the url file path work for windows?

Have you tried building the file path with the file.path() function and seen if this helps instead of using paste0()?

[dunkenwg]

The Windows R-CMD-check is actually failing on this line in sbr_knit_results():

  path <- rmarkdown::render(
    input = input,
    output_format = "html_document",
    quiet = quiet
  )

I tried adding an argument for the output directory that would differ between systems:

  path <- rmarkdown::render(
    input = input,
    output_format = "html_document",
    output_dir = file.path(dirname(file)),
    quiet = quiet
  )

but we're still getting the file path error.

I could try making if/else statements to run different code on Windows, but I don't really know what else to change after scouring the internet on this error. We could also skip this test on Windows, but users likely wouldn't be able to use sbr_knit_results() on Windows. Thoughts?

[aylapear]

This is happening because of the path of the main variable in the "results.Rmd" document we are creating for the test. I tested it on a windows machine and if I switch the slashes to be / or to be \\ then it works fine. I think how we are setting up the test is causing this issue and how the files are used in real cases is a bit different so this issue only pertains to the test structure.

I think we can skip on windows but worth filing an issue on this as there may be a different way to set up the test to be more robust on all OS in the futre. I believe this function will work on windows machines.

[aylapear]

I was incorrect above, this issue is not just about how the test is set up but the purpose of this function which is to created a quick way to view the tables, plots, figures, etc in the report format but it is not actually generating the report we write up.

To fix this we need to make sure it encodes it properly for windows where the "quick" report structure is created. In the report-text.R file try changing the normalizePath(main) to be normalizePath(main, win slash = "/") and see if this will now pass on windows machines and other OS.

[dunkenwg]

@aylapear, this fix worked! If I had to make an (educated) guess as to why test-knit.R is failing on windows when it calls sbr_knit_results(), I'd say it all starts with writeLines(report_text(sub = sub, main = main), con = input) on line 28 of sbr_knit_results(). This line first calls report_text() which writes a really long string. writeLines() then writes this string to results.Rmd. Without the winslash argument in line 11 of report_text() this file fails to render on windows when rmarkdown::render() is called on line 30 of sbr_knit_results().

If I've got the fix correct, you can go ahead and merge the pull request as long as @joethorley is happy with the changes.