Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples and CRAN #55

Open
sckott opened this issue Mar 5, 2024 · 2 comments
Open

examples and CRAN #55

sckott opened this issue Mar 5, 2024 · 2 comments

Comments

@sckott
Copy link
Member

sckott commented Mar 5, 2024

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.

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
Copy link
Contributor

realbp commented Mar 14, 2024

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

@sckott
Copy link
Member Author

sckott commented Mar 14, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants