Milestone 2 Tasks

[cmmclaug]

https://pages.github.ubc.ca/MDS-2020-21/DSCI_524_collab-sw-dev_students/materials/assignments/milestone2.html

Submission

• Create new Python release named v0.2.0
• Create new R release named v0.1.0
• Canvas submission (including repo url of public repo for R repo and Python Repo, url of release for R and Python)

Checklist

• 1. Write test cases and code iteratively
  • arid_eda function
    • Revise function
    • Write test function
    • Write function
    • Handles exceptions with suitable error messages
  • arid_linreg function
    • Revise function
    • Write test function
    • Write function
    • Handles exceptions with suitable error messages
  • arid_logreg function
    • Revise function
    • Write test function
    • Write function
    • Handles exceptions with suitable error messages
  • arid_countreg function
    • Revise function
    • Write test function
    • Write function
    • Handles exceptions with suitable error messages
• 2. Make sure all functions pass pytest package
• 3. Exception handling
  • Erroneous Inputs are handled for all functions
  • Exceptions are tested and provide useful messages
• 4. Verify package functions can be installed and used
• 5. Create project structure for R repo
  • R project structure
  • name related to package
  • MIT license
  • DESCRIPTION file.
  • CONTRIBUTING.md
  • usethis::use_code_of_conduct
  • copy README.md containing:
    • summary paragraph
    • bulleted list of functions
    • package fitting in R ecosystem
• 6. R Function specifications
  • Neel Function
  • Craig Function
  • Daniel Function
  • Santiago Function
• 7. R Project GitHub Mechanics
  • Always add meaningful commit messages
  • Use GitHub Flow workflow
  • Manage GitHub issues for communication
    • Copy this task list or a subset over to R project
  • Verify use of proper grammar and full sentences throughout project.