Documentation: Explanation of why we need compat_friendly_type.R, when to retire and replacements developed to replace it

[bms63]

Please select a category the issue is focused on?

Function Documentation

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

https://github.com/pharmaverse/admiral/blob/main/R/compat_friendly_type.R

• Why did we adopt this code?
• Where is this code used in admiral and admiraldev?
• Explore Alternatives that allow us to remove this code.

Once these are brought over, we need to make a note in the file of why we have them and when they can removed.

Definition of Done

• Create a Details section with @zdz2101 explanations [craft in a way that makes sense for a new user]
• Create a .Rd file
• Make sure entry on site is legible and falls in a category that makes sense.

[zdz2101]

@pharmaverse/admiral to breathe life back into this issue:

• Why did we adopt this code?
  • Looks like it's primarily used to display user-friendly messages on many of our assertion functions
• Where is this code used in admiral and admiraldev?
  • almost strictly housed in admiraldev, but what_is_it() is used in admiral again for user-friendly messages
• Explore Alternatives that allow us to remove this code.
  • as long as we write our own assertions, I don't know if there is a good alternative for now

[bms63]

So the action could be to update the file with your responses? Like a Deatils section in the roxygen header. I also think we should make a .Rd file for this and make it more prominent

[zdz2101]

So the action could be to update the file with your responses? Like a Deatils section in the roxygen header. I also think we should make a .Rd file for this and make it more prominent

Sounds like a good idea!

[bms63]

@pharmaverse/admiral Another easy issue to grab if you are looking to contribute.