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

package-level helpfile #2

Closed
goldingn opened this issue Aug 1, 2018 · 2 comments
Closed

package-level helpfile #2

goldingn opened this issue Aug 1, 2018 · 2 comments

Comments

@goldingn
Copy link

goldingn commented Aug 1, 2018

Something I always look for when getting started with a new package is a package-level helpfile, so I can do ?sdmbench and see some general information about the package, how to get started, and see a roadmap to the available functions.

sdmbench doesn't have one of these yet, but it would be great if it did. You can create one of these with roxygen by documenting a NULL in a script in the R/ folder, like spocc does here.

@goldingn
Copy link
Author

goldingn commented Aug 1, 2018

(note the @docType package line here)

@boyanangelov
Copy link
Owner

Great idea, I just added this. I think the only reason I didn't think about adding it is that it was not mentioned in H. Wickham's "R Packages" book, which was otherwise really helpful!

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