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 documentation to package #15

Open
fontikar opened this issue Apr 18, 2024 · 0 comments
Open

Add documentation to package #15

fontikar opened this issue Apr 18, 2024 · 0 comments

Comments

@fontikar
Copy link
Collaborator

A good R package will contain these 5 forms of documentation:

  1. README which serves as a landing page for whoever finds your repo
  2. Function/objection/package documentation e.g. ?mean()
  3. Vignettes/Long form documentation serves as lengthier explainer of how to use your R package, usually a "Get Started" tutorial and other tutorials for more complex use cases
  4. R package website

{rmot} already has the skeleton for 1-3
To learn more on how to create these : https://fontikar.github.io/DIY_Rpkg/#Document_it_-_Object_documentation_%E2%9C%85

I like to have a look at other packages and see how their write their documentation

For 4 check out: https://github.com/fontikar/DIY_Rpkg_pkgdown and https://fontikar.github.io/DIY_Rpkg_pkgdown/

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