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

add function examples #9

Open
6 of 22 tasks
appling opened this issue May 25, 2015 · 0 comments
Open
6 of 22 tasks

add function examples #9

appling opened this issue May 25, 2015 · 0 comments
Projects
maintenance

Comments

@appling
Copy link
Contributor

appling commented May 25, 2015

Function examples should:

  • Be present in every roxygen2 #' block
  • Include ~2-4 examples
  • Demonstrate common use cases and important options
  • Include library() calls or otherlib::fun() syntax to manage dependencies
  • Only use packages that are also listed in the Imports or Suggests blocks of the DESCRIPTION file
  • Either run quickly and without warning/error, or be wrapped in a \dontrun{} block
  • Use only data available within the package and/or reproducibly generated (e.g., through fixed text definitions of the data, or using set.seed() before random data generation)
  • Run cleanly on package check (Ctrl-Shift-E)

To do:
@appling appling mentioned this issue May 25, 2015
Merged
appling referenced this issue in appling/loadflex May 25, 2015
@appling
doc & tests: uncertainty
de55fc6
This was referenced Jun 7, 2015
Closed
Closed
Closed
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Closed
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
maintenance
Should Do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@appling