169 wrapping up the long code in the Report

[kartikeyakirar]

this Fixes #169

I've implemented a solution that relies on the formatR package. I've ensured that this solution checks for the package in the namespace; if it's not accessible, the user will be notified. To maintain flexibility, I've included the formatR package in the suggested dependencies, as there are no strict dependencies on it.

In response to the feedback provided by @m7pr in this comment, I've updated the default value of global_knitr to list(echo = TRUE, tidy.opts = list(width.cutoff = 60), tidy = FALSE).

Please note that there was an alternative option to set tidy = "styler", but I opted against it due to the additional dependency it would introduce (the styler package). Feel free to review the changes and let me know if any further adjustments are needed.

---

This branch utilizes the functionality provided by the 'formatR' package to automatically add spaces and indentations to the code. However, it does create a strong dependency on the 'formatR' package. If the package is not installed, the output will be generated without any formatting.

Additionally, this branch introduces the following changes:

• It exposes Knitr options to users through the functions 'download_report_button_srv', 'reporter_previewer_srv,' 'simple_reporter_srv,' and the R6 renderer.
• The Roxygen documentation has been updated to reflect these modifications.

changes in reports are observed as follows.

branch: main

branch: 169_wrap_rcode@main

[github-actions]

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  -----------------------------------------------------------------------------------
R/AddCardModule.R       144       2  98.61%   162, 199
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   38-44
R/DownloadModule.R      207      49  76.33%   95-101, 143, 168-173, 182-186, 189-193, 201-205, 208-212, 219-223, 226-230, 267-271
R/FileBlock.R            13       0  100.00%
R/NewpageBlock.R          2       0  100.00%
R/PictureBlock.R         30       2  93.33%   15, 79
R/Previewer.R           295      56  81.02%   188, 202, 204-207, 210, 213-221, 330-374
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R            116      22  81.03%   63, 124, 132, 141, 143-164
R/ReportCard.R           77       4  94.81%   180, 219, 224, 245
R/Reporter.R             94       1  98.94%   254
R/ResetModule.R          55       0  100.00%
R/SimpleReporter.R       30       0  100.00%
R/TableBlock.R            9       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R               171      80  53.22%   7, 38-97, 99, 102-109, 163, 175-177, 287-296
R/yaml_utils.R           81       2  97.53%   41, 239
R/zzz.R                  14      10  28.57%   2-13, 19
TOTAL                  1409     230  83.68%

Diff against main

Filename              Stmts    Miss  Cover
------------------  -------  ------  --------
R/Renderer.R             +1       0  +0.16%
R/SimpleReporter.R       +1       0  +100.00%
R/utils.R               +10     +10  -3.31%
R/zzz.R                 +14     +10  +28.57%
TOTAL                   +26     +20  -1.14%

Results for commit: 71b6d8a

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

    1 files    18 suites   15s ⏱️
204 tests 204 ✔️ 0 💤 0 ❌
346 runs  346 ✔️ 0 💤 0 ❌

Results for commit 71b6d8a.

♻️ This comment has been updated with latest results.

[m7pr]

@pawelru what are your thoughts on this? I know we had some conversation about packages being in Suggests and being checked on a code execution, but this is totally minor and I would accept this the way it is.

[kartikeyakirar]

I have set the default options for global_knitr list(echo = TRUE, tidy.opts = list(width.cutoff = 60), tidy = FALSE)
tidy.opts is set based on https://yihui.org/knitr/options/#chunk-options whereas tidy is FAlSE as default but will be changed to TRUE if formatR package is found in the namespace.

[kartikeyakirar]

I found a better option. If we set tidy = 'formatR', then tidy.opts is not required to remove blank lines and cut the code lines at 60 characters. (making following changes)

[m7pr]

@kartikeyakirar what if we create

options(teal.reporter.knit.global = list(echo = TRUE, tidy.opts = list(width.cutoff = 60), tidy = FALSE))

on a package startup, and then we reuse getOption('teal.reporter.knit.global') in defaults of functions usage? This way we have code that is repeated in many places, but specified once, and is easy to be edited in package, and also during an R sessionl

[m7pr]

https://r-pkgs.org/code.html#sec-code-onLoad-onAttach

[m7pr]

@kartikeyakirar please see my changes to one place where you provided those @details.
Can you make those @details a reusable template with @template? So that it is specified once, and not copy pasted in 4 places

[m7pr]

hey @kartikeyakirar can you run verdepcheck flow to determine the minimal needed version of this package?

[kartikeyakirar]

Can you make those @details a reusable template with @template?

@template is superseded instead I have defined the details in simpleReporter.R and reusing with inherit. thanks for suggestion.

[m7pr]

@kartikeyakirar I wanted you to create roxygen template, not to inherit details.

Please subsitute @inherit simple_reporter_srv details with #' @template roxlate-knitr-details. Also put that in R/SimpleReporter.R instead of details.

Then create a file

man-roxygen/roxlate-knitr-details.R and put below in the content

#' @details To access the default values for the `global_knitr` parameter,  use `getOption("teal.reporter.global_knitr")`. These defaults include:
#' - `echo = TRUE`
#' - `tidy.opts = list(width.cutoff = 60)`
#' - `tidy = TRUE`  if `formatR` package is installed, `FALSE` otherwise

[m7pr]

@kartikeyakirar alrighty, they suggest

Instead of @template and @templateVars write your own function and call it from inline R code.

Can you follow https://rmarkdown.rstudio.com/lesson-4.html ?
Looks like you can use r global_details() which would produce the content of details

[m7pr]

@kartikeyakirar looks good now. That was a long ride.
Would you be able to create a comment that proves that it works? The comparison of a behavior on main with this branch for the usage of all methods/functions that were changed?

[kartikeyakirar]

The comparison of a behavior on main with this branch for the usage of all methods/functions that were changed?

thanks for review @m7pr , I have updated description for this.

[m7pr]

coolio 👍