Documentation: Bring cheatsheet into alignment with 1.1.0 and 1.2.0 changes

[bms63]

Please select a category the issue is focused on?

User Guides

Let us know where something needs a refresh or put your idea here!

We need to align the cheatsheet to admiral 1.1.0. As far as I can tell only derive_var_trtemfl() needs a slight update for new argument. However, there could be others!

Current Cheat Sheet
https://github.com/pharmaverse/admiral/blob/main/inst/cheatsheet/admiral_cheatsheet.pdf

Use this powerpoint to modify Cheat Sheet
https://github.com/pharmaverse/admiral/blob/main/inst/cheatsheet/admiral_cheatsheet.pptx

Definition of Done

• Update derive_var_trtemfl() arguments
• Cross check that no deprecated functions or arguments are in cheatsheet
• Review 1.1.0 news.md to see if any other amendments are needed
• Re-colour bracket in derive_vars_crit_flag()
• Add brackets and remove space in derive_var_base/chg()
• Update bracket colour for convert_blanks_to_na()
• Add derive_vars_cat() and derive_vars_crit_flag() to General Variable-Adding functions
• Add transform_range() to Computation functions for Vectors
• Update derive_vars_atc() to add ... or id_vars argument

@pharmaverse/admiral @pharmaverse/admiral_comm Great way to get more familiar with the package. I would imagine this is a 1-2 hour task. This does not impact 1.1.0 release timelines and so is not needed immediately...but nice to have in the next week.

[bundfussr]

I had a look. I think we don't need to update derive_vars_trtemfl() because on the cheatsheet only the main arguments are mentioned. Thus I wouldn't add group_var.

I would update only derive_vars_atc() by adding the new argument id_var or just ... depending on what fits.

However, I noticed that the webpage links to the development version of the cheatsheet. I.e., the users already see the derive_vars_crit_flag() function although it is not yet available. I wonder if should change the links such that it refers to the released version. We could submit our cheatsheet to rstudio/cheatsheets and refer in our documentation to the cheatsheet in rstudio/cheatsheets.
Another option would be to copy the cheatsheet from the inst folder to the docs folder when we build the documentation and refer to the docs folder in the documentation. However, the first options seems the more common one to me.

@bms63 , @manciniedoardo , what do you think?

[bms63]

I like submitting to rstudio/cheatsheets. Gets us more exposure.

[manciniedoardo]

I like the idea too!

[bundfussr]

OK, I'll submit the cheatsheet for 1.1.1.

[bundfussr]

@manciniedoardo , for the submission to rstudio/cheatsheets I need to add an author name to the cheatsheet. As you did most of the work, I would suggest to add your name.

Do you agree?

[manciniedoardo]

@bundfussr yes sure, thanks!

[bundfussr]

I've submitted the cheatsheet: rstudio/cheatsheets#555

[bms63]

Thanks @bundfussr !!

[bundfussr]

I've created the branch 2458_update_cheatsheet to store the admiral 1.1.1 cheatsheet. However, this branch shouldn't be merged to main as it would conflict with the cheatsheet updates for #2468. I'll add the admiral 1.1.1 cheatsheet updates to the 2468_derive_vars_crit_flag branch.

[github-actions]

This issue is stale because it has been open for 90 days with no activity.

[manciniedoardo]

As discussed with @bundfuss, the PR to add the cheatsheet to Rstudio/cheatsheets is still not merged. So we can use this opportunity to make changes to align with 1.2 and then perhaps update that PR as well.