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

Add @usage data('diamonds') to vignettes/rd-other.Rmd #1701

Open
zettlchen opened this issue Feb 11, 2025 · 0 comments
Open

Add @usage data('diamonds') to vignettes/rd-other.Rmd #1701

zettlchen opened this issue Feb 11, 2025 · 0 comments

Comments

@zettlchen
Copy link

Dear developers,
thank you for your great work!

When documenting a dataset, I followed the template you provide in vignettes/rd-other.Rmd.

This structure caused a warning in R CMD check --as-cran:

  • checking for code/documentation mismatches ... WARNING
    Variables with usage in Rd file 'datadoc.Rd' but not in code:
    ‘docdata’

After a bit of trial and error, this warning could be removed by adding a usage section to the documentation block:
#' @Usage data('docdata')

I'm convinced that if you were to add a simple @Usage data('diamonds') to your example on data documentation, you could help many future users avoid unnecessary CRAN check warnings.

Best, Lena

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

1 participant