examples and CRAN - Githubissues

sckott commented 5 months ago

On CRAN submission and their daily checks if examples fail you'll hear about it and have to fix it typically within 2 weeks. Just a note to think about WHEN examples are run

There's a number of solutions.

\dontrun as you use in some of your egs
@examplesIf https://roxygen2.r-lib.org/articles/rd.html#examples, this could be:
- @examplesIf interactive() - i think this would avoid cran running them, but not totally sure
- @examplesIf check_if_website_is_up()

And it's not just whether they fail but if how long they take. I don't know exact numbers, but CRAN will complain if they take too long

realbp commented 5 months ago

@sckott I have \dontrun on all of the functions that I export. would that be sufficient?

sckott commented 5 months ago

I don't know what the latest is on whether CRAN runs examples in \dontrun. I'm pretty sure they don't, but you can check by submitting to winbuilder and they run checks on your package when you first submit to cran as well.

Keep in mind that CRAN won't like it if no examples run. So if you have any functions that do not do HTTP requests, those are the ones you should have run every time.

getwilds / cancerprof

examples and CRAN #55