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.

Sign up for GitHub

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

Jump to bottom

Package documentation #8

Open
pitkant opened this issue Jun 28, 2024 · 0 comments
Open

Package documentation #8

pitkant opened this issue Jun 28, 2024 · 0 comments
Assignees
@arvitolvanen
Labels
enhancement New feature or request

Comments

@pitkant
Copy link
Member

pitkant commented Jun 28, 2024

The package could have the following documentation:

  • vignette, in English (included with the package, see examples from existing installed packages vignette(package = "packagename"))
  • article, in Finnish (not included with the package but readable in the package website)
  • README, included in the Github repo front-page, contains basic information and maybe one or max two examples
  • NEWS, included with the package, documents changes between versions
  • function documentation

See R Packages (2e) chapter 16 on function documentation, chapter 17 for information on vignettes and articles and chapter 18 for more information on README and NEWS
@pitkant pitkant added the enhancement New feature or request label Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arvitolvanen arvitolvanen

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pitkant @arvitolvanen