roxygen2 tag

[maelle]

How nice would it be to have something like

#' @exampleVcr cassette-name
#' <code>

instead of

#' @examples 
#' \dontshow{insert_example_cassette("cassette-name", package = "package-name")}
#' <code>
#' \dontshow{eject_example_cassette()}

Now, the only usage of insert_example_cassette() I could find is in ellmer where there is a bit more setup/cleaning anyway: https://github.com/tidyverse/ellmer/blob/4223c73094a7fb4027f811283fa30c73182c921b/R/utils.R#L263 @hadley

Besides, insert_example_cassette() has other arguments. Maybe the syntax of the examples could somehow be closer to the syntax of vignette chunks, so that the arguments could be passed as knitr options?

In any case, the syntax for vcr usage in examples feels very clunky compared to the smoothness of using vcr in tests and vignettes. 😇

[sckott]

Good idea @maelle !

the only usage of insert_example_cassette() I could find is in ellmer

as you can imagine, not too surprising since hadley just added it. but i imagine we'll see more usage soon.

@exampleVcr cassette-name

This would be very cool. I guess hadley could tell us if that's feasible? If it means a dependency on vcr i imagine that wouldn't work

[maelle]

I think in this case the roxygen2 tag would live in vcr, and then packages would take a dependency on vcr. I only know what I wrote in https://masalmon.eu/2024/09/03/roxygen2-custom-tag/, where I might have gotten some things wrong. 😅

Thoughts @hadley?

[hadley]

Hmmm, it would be nice to eliminate that boilerplate, but the problem with a new tag is that RStudio/Positron won't recognise it and give you the nice example behaviour. Maybe that's an ok tradeoff though?

(The other problem is that I have literally no recollection of how to create a new roxygen2 tag outside of roxygen2 😆)

[maelle]

Let me try to prepare a PR to vcr.

I will call the tag examplesVcr not exampleVcr so that it might be covered by the IDEs just as @examplesIf should. I found the examplesIf-related issues in the repos of the IDEs:

• RStudio: Code > Reflow Comment (Ctrl/Cmd+Shift+/) does not work well with @examplesIf rstudio/rstudio#14327
• Positron: roxygen examples and examplesif not the same posit-dev/positron#2318