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

outliers_detect() #7

Open
1 of 24 tasks
GuiFabre opened this issue Jan 17, 2024 · 0 comments
Open
1 of 24 tasks

outliers_detect() #7

GuiFabre opened this issue Jan 17, 2024 · 0 comments

Comments

@GuiFabre
Copy link
Contributor

testing of a function:

  • run the function :
    • with demo examples (common usage)
    • with demo examples (bugs scenarios - make errors combo with each parameter)
    • with real data
    • try different combinations (common usage, other usages, on purpose errors, handle exceptions) (if possible)
  • validation of the function component
    • validate/propose name of the function
    • validate/propose parameters names (need more/less params?)
    • validate/propose output generated
  • generate documentation (mandatory in bold)
    • title
    • description
    • details
      • each parameter has it owns detail
    • param
    • returns
    • seealso
    • examples
  • include in the package
    • add life cycle informations (if needed, 'experimental') and update lifecycles of others ('superseded', 'deprecated')
    • test for CRAN
    • add comment in NEWS.Rmd
    • change website (if needed : references, vignette(s), main page...)
  • communicate function availability

Run tests until consensus. Change life cycle if needed ('stable')
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
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GuiFabre