Post about different types of examples

[maelle]

dontrun, donttest, dontshow, etc.

examples package coverage

https://testthat.r-lib.org/reference/test_examples.html

have a look over the CRAN mirror repos.

maybe a few R-pkg-devel links.

[maelle]

Tip https://twitter.com/WeAreRLadies/status/1064734591641104384?s=19 by Mine CR

Rundontrun in pkgdown

[maelle]

dontshow use cases

• r-hub/pkgsearch@5bc4c66
• in https://kbroman.org/pkg_primer/pages/cran.html " \dontshow{} to add a bit of code to subset an example dataset to make it much smaller and to make subsequent commands faster."

[maelle]

https://roxygen2.r-lib.org/articles/rd.html#functions

From Rd to code to run for examples
https://github.com/wch/r-source/blob/58b081562010c9394b1df6937ed183269e3ecf93/src/library/tools/R/Rd2ex.R#L62

https://github.com/wch/r-source/blob/58b081562010c9394b1df6937ed183269e3ecf93/src/library/tools/R/Rd2ex.R#L176

My search https://github.com/search?utf8=%E2%9C%93&q=donttest+repo%3Awch%2Fr-source+extension%3AR+language%3AR+language%3AR&type=Code&ref=advsearch&l=R&l=R

[maelle]

What's run with example() https://github.com/wch/r-source/blob/861905f8c701de8dc673e7c218f808f35d82190a/src/library/utils/R/example.R#L20

run.dontrun = FALSE, run.donttest = interactive()

[maelle]

In https://github.com/wch/r-source/blob/06185bd431beb9b6e0883193273d1779ef2c6a2c/src/library/tools/R/testing.R testInstalledPackage calls .createExdotR(pkg, pkgdir, silent = TRUE, ...). By default it comments out dontrun and donttest but this can be toggled.

[maelle]

For checks https://github.com/wch/r-source/blob/28fc79da885b3323e1f8ca6351736e15b96be551/src/library/tools/R/check.R#L3855

[maelle]

https://stat.ethz.ch/pipermail/r-package-devel/2018q3/003084.html

[maelle]

where to store examples (with roxygen2, not necessarily in the R file, probably more natural not to write them with "##" in front)

[maelle]

https://github.com/search?utf8=%E2%9C%93&q=%22%5Cdontrun%7B%22+user%3Acran+extension%3ARd&type=Code&ref=advsearch&l=&l= 19,247 dontrun in CRAN Rd files

https://github.com/search?q=%22%5Cdonttest%7B%22+user%3Acran+extension%3ARd&type=Code 2,024 donttest in CRAN Rd files

https://github.com/search?q=%22%5Cdontshow%7B%22+user%3Acran+extension%3ARd&type=Code 1,228 dontshow

[maelle]

no mention of dontrun/donttest in https://cran.r-project.org/web/packages/policies.html

[maelle]

https://stat.ethz.ch/pipermail/r-package-devel/2018q2/002811.html and its answer

"Sure, \dontrun{} markup is intended for cases where neither automated
chercks nor users can expect that the given code work out of the box
and, e.g., changes are needed to make it work, e.g. isertion of otehr
useranmes ... while \donttest{} is expected to work out of the box
(perhaps code that only work interactively or excluded in order to omit
ling running examples from the checks). Nothing new here."

[maelle]

https://cran.r-project.org/doc/manuals/R-exts.html#index-_005cdontrun

[maelle]

works out of the box but long or interactive -> donttest

doesn't work out of the box or doesn't work at all -> dontrun

e.g. to get a subset of the example data -> dontshow