51 pre-CRAN release updates

[m7pr]

Closes #51

Hey @donyunardi I did

• updated Readme with guidelines from this task https://github.com/insightsengineering/coredev-tasks/issues/462
• did not group vignettes in a meaningful structure as we only have one vignette
• confirmed that package passes checks with --as-cran argument

Would you like to schedule a team meeting where we would release and tag the package to GitHub all together?

==> devtools::check(args = c('--as-cran'))

══ Documenting ═════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
ℹ Updating teal.logger documentation
ℹ Loading teal.logger

══ Building ════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
Setting env vars:
• CFLAGS    : -Wall -pedantic -fdiagnostics-color=always
• CXXFLAGS  : -Wall -pedantic -fdiagnostics-color=always
• CXX11FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX14FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX17FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX20FLAGS: -Wall -pedantic -fdiagnostics-color=always
── R CMD build ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
✔  checking for file 'C:\Rprojects\teal.logger/DESCRIPTION' (417ms)
─  preparing 'teal.logger': (496ms)
✔  checking DESCRIPTION meta-information ... 
─  installing the package to build vignettes
✔  creating vignettes (4.1s)
─  checking for LF line-endings in source and make files and shell scripts
─  checking for empty or unneeded directories
   Omitted 'LazyData' from DESCRIPTION
─  building 'teal.logger_0.1.1.9011.tar.gz'
   
══ Checking ════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
Setting env vars:
• _R_CHECK_CRAN_INCOMING_REMOTE_               : FALSE
• _R_CHECK_CRAN_INCOMING_                      : FALSE
• _R_CHECK_FORCE_SUGGESTS_                     : FALSE
• _R_CHECK_PACKAGES_USED_IGNORE_UNUSED_IMPORTS_: FALSE
• NOT_CRAN                                     : true
── R CMD check ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
─  using log directory 'C:/Rprojects/teal.logger.Rcheck' (484ms)
─  using R version 4.3.0 (2023-04-21 ucrt)
─  using platform: x86_64-w64-mingw32 (64-bit)
─  R was compiled by
       gcc.exe (GCC) 12.2.0
       GNU Fortran (GCC) 12.2.0
─  running under: Windows 10 x64 (build 19044)
─  using session charset: UTF-8
─  using options '--no-manual --as-cran'
✔  checking for file 'teal.logger/DESCRIPTION'
─  this is package 'teal.logger' version '0.1.1.9011'
─  package encoding: UTF-8
✔  checking package namespace information
✔  checking package dependencies (747ms)
✔  checking if this is a source package ...
✔  checking if there is a namespace
✔  checking for executable files (529ms)
✔  checking for hidden files and directories ...
✔  checking for portable file names
✔  checking whether package 'teal.logger' can be installed (2.3s)
✔  checking installed package size ... 
✔  checking package directory
✔  checking for future file timestamps ... 
✔  checking 'build' directory
✔  checking DESCRIPTION meta-information ... 
✔  checking top-level files
✔  checking for left-over files
✔  checking index information ... 
✔  checking package subdirectories ... 
✔  checking R files for non-ASCII characters ... 
✔  checking R files for syntax errors ... 
✔  checking whether the package can be loaded (443ms)
✔  checking whether the package can be loaded with stated dependencies (448ms)
✔  checking whether the package can be unloaded cleanly (567ms)
✔  checking whether the namespace can be loaded with stated dependencies (464ms)
✔  checking whether the namespace can be unloaded cleanly (569ms)
✔  checking startup messages can be suppressed (1.1s)
✔  checking dependencies in R code (455ms)
✔  checking S3 generic/method consistency (664ms)
✔  checking replacement functions (446ms)
✔  checking foreign function calls (444ms)
✔  checking R code for possible problems (3.7s)
✔  checking Rd files (352ms)
✔  checking Rd metadata ... 
✔  checking Rd line widths ... 
✔  checking Rd cross-references ... 
✔  checking for missing documentation entries (461ms)
✔  checking for code/documentation mismatches (1.4s)
✔  checking Rd \usage sections (802ms)
✔  checking Rd contents ... 
✔  checking for unstated dependencies in examples ... 
✔  checking installed files from 'inst/doc'
✔  checking files in 'vignettes'
✔  checking examples (1.7s)
✔  checking for unstated dependencies in 'tests' ... 
─  checking tests ...
✔  Running 'testthat.R' (838ms)
✔  checking for unstated dependencies in vignettes ... 
✔  checking package vignettes in 'inst/doc' ...
✔  checking re-building of vignette outputs (1.4s)
✔  checking for non-standard things in the check directory
✔  checking for detritus in the temp directory
   
   
── R CMD check results ───────────────────────────────────────────────────────────────────────────────────── teal.logger 0.1.1.9011 ────
Duration: 25.4s

0 errors ✔ | 0 warnings ✔ | 0 notes ✔

R CMD check succeeded

[github-actions]

Unit Tests Summary

10 tests   10 ✔️  0s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit bbff5d0.

♻️ This comment has been updated with latest results.

[github-actions]

Code Coverage Summary

Filename               Stmts    Miss  Cover    Missing
-------------------  -------  ------  -------  ---------
R/register_logger.R       56       1  98.21%   113
R/supress_logs.R           5       5  0.00%    17-21
R/utils.R                 17       0  100.00%
R/zzz.R                    2       2  0.00%    3-4
TOTAL                     80       8  90.00%

Diff against main

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

Results for commit: c90a7e2

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[donyunardi]

Thanks for the work so far @m7pr !

I have two additional requests:

• Can we also update NEWS.md file and add a line there for these documentation changes?
  Since we're doing preliminary release first, we will perform v0.1.2 release before pushing to CRAN.
• Can we review the vignette's content too (making sure teal is lowercase, all code is formatted properly, etc.), similar to what @pawelru did in the teal PR?

And yes, I think it's a good idea to get together again to see how to release and tag the package.
I'll schedule something once we merge this PR.

[m7pr]

Hey @donyunardi thanks for the review.

• For NEWS.md : Sure! This is just a tiny input that I provided in this file with those 2 commits f6e1527 7158080 I wasn't sure when we actually bump to v.0.1.2 but I guess this happens on a release-tag phase that we will do once this is merged right?
• For vignettes: I did review the vignette, which is really short and doesn't have much content so there was no need to fix formatting or the code. However I actually fixed the text - you can see that in this commit 2382d83

[donyunardi]

I would like to get some input on this date line:

teal.logger/vignettes/teal-logger.Rmd

Line 4 in 04b969f

date: "15.03.2022"

I rarely see dates in vignettes in other packages, and if we want to maintain this practice, then I suppose we'll need to update it every time we make changes to the vignette. It also gives the wrong impression that the vignette hasn't been maintained when the date is too far back in the past.

What do you think if we remove this?

[m7pr]

@donyunardi

It also gives the wrong impression that the vignette hasn't been maintained when the date is too far back in the past.
Totally I support your point/view. Removed that in 7ecd3dd

[donyunardi]

Approved!