Add roxygen2 template for common arg names/descriptions

[ddsjoberg]

Please select a category the issue is focused on?

Function Documentation

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

http://cran.nexr.com/web/packages/roxygen2/vignettes/rd.html

[ddsjoberg]

roxygen2 templates have been superseded.

My interpretation of the suggestion is to write an internal function that will be called in-line.

param_by_var_description <- function() "A list of expressions created using `exprs()` identifying groups of records in which to look for duplicates"

Then the roxygen comment would look like this:

#' @param by_var `r param_by_var_description()`

Is that how you're reading the suggestion as well? @pharmaverse/admiral ?

[bundfussr]

Yes, I would read it in the same way.

Maybe we need some conventions for such documentation functions, e.g., where to store them, how to name them, ....
Do we need unit tests for them?

[ddsjoberg]

Thanks @bundfussr ! I'll put together a draft PR with one or two description updates. Once we're all aligned, I'll complete the updates.

[bms63]

Another nice to have for standard text that isn't param related but we want to only update in one place.

See discussion here: #2118 (comment)