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 #19

Open
KevCaz opened this issue Dec 19, 2016 · 3 comments
Open

Examples #19

KevCaz opened this issue Dec 19, 2016 · 3 comments
Labels

Comments

@KevCaz
Copy link
Member

KevCaz commented Dec 19, 2016

Should examples be madatory for keys functions? A good vignette may be sufficient.

@SteveViss
Copy link
Contributor

Not mandatory for now.

@tpoisot
Copy link

tpoisot commented Jul 13, 2017

Aren't they checked by CRAN?They're also easier to look at than vignettes, because they appear directly within the help / documentation. I think they should be highly recommended.

@KevCaz
Copy link
Member Author

KevCaz commented Jul 13, 2017

Examples and vignettes are indeed checked by CRAN (and locally using R CMD CHECK or the Wickham's flavored R-CMD-CHECK in devtools package). So let's say we HAVE TO provide example.

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

No branches or pull requests

3 participants