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

Need standard way of recording package-level roxygen3 metadata #34

Open
hadley opened this issue Aug 13, 2013 · 0 comments
Open

Need standard way of recording package-level roxygen3 metadata #34

hadley opened this issue Aug 13, 2013 · 0 comments

Comments

@hadley
Copy link
Owner

hadley commented Aug 13, 2013

  • Whether or not to use markdown
  • Whether or not to use autoImports
  • Which roclets to run by default
  • Which version of roxygen to run

The obvious place to put this information would be in the DESCRIPTION. One option would be to use a common prefix:

Roxygen-version: 2
Roxygen-markdown: false
Roxygen-roclets: namespace, collate
Roxygen-autoimports: true

Another possibility would be to create an R object:

Roxygen: list(version = 2, markdown = F, roclets = c("namespace", "collate")), autoimports = FALSE)

Since we'd control when that evaluation occurred, it could even be a nicer function:

Roxygen: roxy_options(markdown = T, ver = 2)

But that would make life a bit harder for devtools which also needs to know which version of roxygen to run.

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