Release 1.3: Common tasks, Dev acknowledgement, versioning, helper packages/websites, etc

[manciniedoardo]

Master PR

Common Release Tasks

All of these small Release Tasks should be done in one issue and not split out across multiple issues and PRs. I have created a common task list for us to check and hope to develop the task (if needed) below. If we can standardized this stuff, then we could build a release_function that is a wrapper around the https://usethis.r-lib.org/reference/use_release_issue.html

Prepare for release:

• New devs to description file and old devs to acknowledgements
• Review FAQs
• Review Cheatsheet Documentation: Updates to cheatsheet for 1.3 #2758 - as per feedback from last process, doing this in a separate issue as we wish tomerge it right before 1.3 release.
• Polish news
• Update README schedule for future releases
• Review pharmaverse admiral youtube videos (https://www.youtube.com/channel/UCxQFEv8HNqM01DXzdQLCy6Q)
• Check Size of package ( Code here )
• Check version numbers are correct in DESCRIPTION (i.e. admiraldev, pharmaversesdtm, others?)
• Check Remotes is removed form DESCRIPTION
• Check current CRAN check results
• Scan and remove non-ascii characters - Remove non-ascii characers #2456
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• urlchecker::url_check() checked as of 19th June
  
• devtools::check(remote = TRUE, manual = TRUE) output as of 19th June:
  
• devtools::check_win_devel() - doesn't work with Remtoes
• Run roche templates
• Use Insight Engineering reverse dependency checks. Requires manually running the Action
• Draft blog post

Submit to CRAN:

• Be sure to use [skip vbump] in PR Title to prevent upversioning
• usethis::use_version('major')
• devtools::submit_cran()
• Approve email
• Monitor submission form here: https://r-hub.github.io/cransays/articles/dashboard.html
• Start using CRAN Comments, usethis::??

CRAN Accepted:

• usethis::use_github_release()
• usethis::use_dev_version()
• Finish blog post
• Add Releases and tar.gz file to the Release
• Review admiraldiscovery (presentations and find a function)
• Push forward deprecation

Loose Guidance for particular tasks

New presentations

• Merck Presentation on LLM
• Lilly Presentation on LLM (?)
• Daniel and Ben's Whats in a message

pharmaverse/admiraldiscovery#64

News devs to description File and old devs to acknowledgements - NB: check admiraldev as well

#2748
pharmaverse/admiraldev#492

• Gayatri
• Junze
• Arianna

Devs to moved to acknowledgments (not actively working on admiral anymore) at the bottom of README:

• person("Sadchla", "Mascary", role = "aut"),
• person("Sophie", "Shapcott", role = "aut"),
• person("Eric", "Simms", role = "aut"),
• person("Phillip", "Webster", role = "aut"),
• person("Zelos", "Zhu", role = "aut"),

New acknowledgements

• clarkliming for Bug: slice_derivation() fails when there is no records that meet the filter criteria #1309
• @ynsec37 for Feature Request: Use all variables for extract_duplicate_records by default #2644
• @SolveigHolmgaard
• Acknowledge those removed from the DESCRIPTION list
• Check closed PRs for mini-PRs and issues raised by users

Review FAQs

• Check for outdated info
• Chances to consolidate information or remove
• Possible to link to other information to help minimize upkeep

Polish News

• Each news item should have a linked issue
• Check for consistency and grammar

[bms63]

Cool Issue Template - https://github.com/insightsengineering/teal/issues/new?assignees=KlaudiaBB%2Ccicdguy&labels=release&projects=&template=release.yml&title=%5BRelease%5D%3A+%3Cversion%3E

[bms63]

Making note here on cheatsheet - needs a little more thought on when to update #2600

[bms63]

I don't know what this means? @manciniedoardo

[ddsjoberg]

@bms63 I wouldn't worry about the qpdf and latex warnings. If you want, you can install it on your machine to avoid the message. Resolving the latex warning will depend on how the latex distribution on your machine, so I would just ignore it. These both arise from building the PDF manual, which CRAN does on their end anyway.

Has the size of the package grown since the last release? Unless the rules have changed, you may be auto-rejected because the build is >5MB. But I know there are packages that exceed this size on CRAN, but I have never gone through that process. 🤷🏼

[bms63]

Thanks @ddsjoberg!!! I was more poking at @manciniedoardo about what we are doing about these warnings and notes - we should be all clean.

• I have a linux installation with qpdf installed so this one doesn't come up for me.
• when i do a manual check on the size for latest admiral dev I get this
  
• Not sure on the tidy Note ?
• @manciniedoardo maybe add to .Rbuildignore the admiral-manual.tex so it doesn't show up as a Note?

[bms63]

Sniff out unicode characters in .Rd files

search_specific_unicode_in_rd_files <- function(folder_path, unicode_char) {

List all .Rd files in the folder

rd_files <- list.files(path = folder_path, pattern = "\.Rd$", full.names = TRUE)

for (file in rd_files) {
# Read each .Rd file
rd_content <- readLines(file, encoding = "UTF-8")

# Identify lines containing the specific Unicode character
has_unicode <- grepl(unicode_char, rd_content)
unicode_lines <- rd_content[has_unicode]

if (length(unicode_lines) > 0) {
  cat("File:", file, "\n")
  cat("Lines with the Unicode character ℹ:\n")
  print(unicode_lines)
  cat("\n")
}

}
}

Define the Unicode character (information source symbol)

unicode_char <- "ℹ"

Run the function with your folder path

search_specific_unicode_in_rd_files("/cloud/project/man", unicode_char)

[bundfussr]

On linux/unix systems you could also use

grep --color=auto $(printf \\U2139) *.Rd

[bms63]

grep forever!! much simpler :)