Fix 12 create report template

[insightsurge]

Link to the Issue

Closes #12

Definition of Done

This is an intermediate PR to fix the feature/PR implemented by maria in maria-12-create-report-template

• Lint fixes and cleaned unnecessary new lines.
• Directory selection box will appear if report_dir param is NA or an empty string.
  This uses Rstudio API to select a folder as it's OS-independent. utils::choose.dir() only works on windows. This indicates that interactive folder picker will be visible only when user uses rstudio and won't work on other IDEs like VSCode etc. A message for this is also added.
• Linter defaults added to avoid no visible global function definition lint fail.
• Message will be shown if user doesn't pass value for report_dir

How to test changes

...

Tasks for PR author

• Test your change and ensure there is no regression
• Change has a corresponding issue. Ensure it is linked in GitHub
• Author of the change opened a pull request and assigned a reviewer

General policy:

• If applicable - add instructions for testing
• If there’s no issue, create it. Each issue needs to be well defined and described.
• All interaction with a user, user-facing messages, plots, reports etc. are written from the perspective of the person using or receiving it. They are understandable and helpful to this person. If a user sees an error message, there is a call to action, i.e. the user knows what to do to fix it.
• README, other documentation and code comments that we have is updated with all information related to the change.
• All code has been peer-reviewed before merging into any main branch
• All changes have been merged into the main branch we use for development.
• Continuous integration checks (linter, unit tests, integration tests) are configured and pass.
• Optional: unit tests added for all new or changed logic.
• All task requirements satisfied. If not describe it here. The reviewer is responsible to verify each aspect of the task.
• Change covers only things in task. Please create new PR if you want to fix something else.

[ineelhere]

Great work @insightsurge 👍🏼

• Requirements on DOD are fulfilled.
• While testing on windows it gives the following error

Structure created at C:\Users\****\AppData\Local\Temp\*****
Switched to develop
cannot open the connectionSwitched back to feature
Warning message:
In file(file, "rt") :
  cannot open file 'C:/Users/****/AppData/Local/Temp/****/tests/cypress/performance.txt': No such file or directory
  

• This seems linked to the error in the CI https://github.com/Appsilon/shiny.benchmark/actions/runs/6572452833/job/17853599308?pr=109#step:7:18
• Working on this issue - [Bug]: Tests' pipeline is not working #108 might find a fix for the above errors.

[DouglasMesquita]

Thanks for this PR, @insightsurge

I think the improvements in the messages and interaction are good. However, I was not able to generate the report. Maybe I am doing something wrong here. I was not able to do that using the report_dir and also not able to run it manually with create_report function. It seems the structure that the report is expecting is different than the one we are passing as input to the function. Were you able to generate the HTML?

[insightsurge]

It seems the structure that the report is expecting is different than the one we are passing as input to the function. Were you able to generate the HTML?

Yes, I also faced error while generating HTML for report. But we can merge this branch inside maria's branch and cover the rest there as the feature can be really helpful for the end user.

[DouglasMesquita]

It seems the structure that the report is expecting is different than the one we are passing as input to the function. Were you able to generate the HTML?

Yes, I also faced error while generating HTML for report. But we can merge this branch inside maria's branch and cover the rest there as the feature can be really helpful for the end user.

Agree. I will proceed and merge it then

[DouglasMesquita]

We will merge it into fix-12-create-report-template and fix it from there