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

roxygen annotation #13

Open
Shicheng-Guo opened this issue Jul 7, 2016 · 1 comment
Open

roxygen annotation #13

Shicheng-Guo opened this issue Jul 7, 2016 · 1 comment

Comments

@Shicheng-Guo
Copy link

This book is really useful. A naive question: Which files need to provide roxygen annotation? roxygenize('rmini') will creat all the Rd files right? How to determine the fileanme of the Rd files?

@yihui
Copy link
Owner

yihui commented Jul 7, 2016

Roxygen comments are written in .R files under the R/ directory.

The Rd filenames are determined by the function names, unless you explicitly provide the @rdname tag . For example, a function foo will generate foo.Rd; if you provide @rdname bar, the Rd will be bar.Rd. More info here: https://cran.rstudio.com/web/packages/roxygen2/vignettes/rd.html

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