208 CRAN requirements for the first submission [skip vbump]

[m7pr]

Closes #208 Closes #201

• satisfies DESCRIPTION requirements.
• needed to remove ::: from documentation - this required to
  • update teal.reporter:::ReportCard to teal.reporter::ReportCard as this is exported object
  • update teal.reporter:::Report to teal.reporter::Report as this is exported object
  • delete $append_content() method examples as they used teal.reporter:::NewpageBlock which is unexported
  • delete manual pages for internal, unexported objects: Archiver, ContentBlock, FileArchiver, FileBlock, JSONArchiver, NewpageBlock, PictureBlock, RcodeBlock, Renderer
    • above can still be visible in R/ directory in the source code of classes

[m7pr]

Tagging @chlebowa @gogonzo and @donyunardi to let you know that internal manual pages will not be accepted on CRAN as they use ::: sign to access non-exported functions.

[github-actions]

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  ----------------------------------------------------------------------------------
R/AddCardModule.R       140       1  99.29%   195
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   38-44
R/DownloadModule.R      207      49  76.33%   89-95, 138, 163-168, 177-181, 184-188, 196-200, 203-207, 214-218, 221-225, 262-266
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%   183, 197, 199-202, 205, 208-216, 325-369
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R             84      13  84.52%   95, 103, 112, 114-126
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       29       0  100.00%
R/TableBlock.R            8       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R                78      66  15.38%   7, 38-97, 99, 102-109
R/yaml_utils.R           74       2  97.30%   41, 239
TOTAL                  1257     196  84.41%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 23a3a45

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

    1 files    18 suites   10s ⏱️
195 tests 195 ✔️ 0 💤 0 ❌
334 runs  334 ✔️ 0 💤 0 ❌

Results for commit fd03911.

♻️ This comment has been updated with latest results.

[donyunardi]

We will use this PR to track CRAN feedback/update/release and GH release based on our release process steps.

So I will:

1. Up-version the package (0.2.1) + update PR title to skip vbump.
2. Built this locally and submit to CRAN
3. git tag v0.2.1-rc# and push
4. Address any CRAN feedback and repeat steps 2 and 3 until CRAN approves.
5. Once in CRAN, then we will merge this to main and tag v0.2.1 for GH release

We probably need to block any PR to main during this time.

[donyunardi]

delete manual pages for internal, unexported objects: Archiver, ContentBlock, FileArchiver, FileBlock, JSONArchiver, NewpageBlock, PictureBlock, RcodeBlock, Renderer
above can still be visible in R/ directory in the source code of classes

Since we are removing the .Rd files for internal/unexported objects, should we be more consistent by adding the @noRd tag to all internal and unexported objects and functions?

For example:

teal.reporter/R/DownloadModule.R

Lines 155 to 156 in 55e890a

	#' @keywords internal
	report_render_and_compress <- function(reporter, input_list, global_knitr, file = tempdir()) {

If so, perhaps we should make it consistent throughout all teal packages?

[gogonzo]

Please remove examples where ::: occurs. I get a response as follows:

Since these examples are for unexported functions and are accessed in their examples, please do not use examples for unexported functions at all. Those functions are only ment to be used internally. If you believe they need examples, then they probably should be exported.

---

In this PR I see some examples were changed from ::: to :: does it work?

[m7pr]

Hey @gogonzo the change from ::: to :: worked only for exported functions teal.reporter:::ReportCard -> teal.reporter::ReportCard and teal.reporter:::Report -> teal.reporter::Report.

For non-exported functions I will only delete examples and will bring back manual pages (without examples) so noRd tag disappears. We can move examples for non-exported functions to dev/examples.R file, that will be added to .Rbuildignore so it's not added to the sourced package that we will re-submit to CRAN

[m7pr]

Hey, just moved examples do dev/internal_examples.R

[m7pr]

@donyunardi would you like to take care of a resubmission to CRAN?

[donyunardi]

Resubmitted to CRAN as 0.2.1.
Creating tag 0.2.1-rc1.
Waiting for further CRAN feedback.

[m7pr]

Resubmitted again to CRAN as 0.2.1. after we received #208 (comment)

[donyunardi]

Create and push v0.2.1-rc2 tag.
Waiting for further feedback.
Hopefully this is it 🤞🏼

[donyunardi]

teal.reporter is now in CRAN:
https://cran.r-project.org/web/packages/teal.reporter/index.html