Pre-release activities

[donyunardi]

Summary

Please carry out these tasks in preparation for the CRAN release:

1. Review and update:
   • README.md (check example code)
   • NEWS.md
2. Run urlchecker::url_check() to identify broken links and fix
3. Review functions:
   • @example tag, make sure it runs, fix if otherwise
   • Make sure functions has @return tag to document the return value
   • no \dontrun tag, replace with if(interactive()) if needed
4. Sanity check of all vignettes, make sure there is no typo, no wrong format, etc.
5. Run R CMD check --as-cran make sure everything pass

This needs to be done for the following repos:

• Pre-release activities teal.code#189 @kartikeyakirar
• Pre-release activities teal.data#240 @kartikeyakirar
• Pre-release activities teal.slice#506 @kartikeyakirar
• Pre-release activities teal#1021 @kartikeyakirar

Please assign your name to the checkbox and perform the pre-release activities.
Create PR if fix is needed.

[m7pr]

Also make sure

• Package Title is not duplicated in Package Description in DESCRIPTION file (e.g. this happens in teal.slice currently)
• All package names in Title and Description fields of DESCRIPTION file are quoted with '
• You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files
• Make sure there are no ::: in examples
• Make sure all teal.* mentions are lower-cased and quoted
• Make Sure inst/WORDLIST is minimalized
• Make sure non-exported functions do not have examples
• Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address but it has /latest/ instead, so we always expose the documentation of the latest release and not what's currently on main branch but not yet released

[averissimo]

Following-up on @chlebowa comment on applying insightsengineering/teal.slice#518 to all core packages (graceful handling of Suggested packages and skipping tests that use them)

(comment) I suppose we will do this in all package, not just teal.slice, correct?

Should we do this, and if so should it be part of the pre-release activities or track it in a different tasks on this repo?

[chlebowa]

I know for a fact that it is an issue in teal but I haven't looked at other packages yet. If it's limited to teal, I say we do it now.