Write the documentation for function 1: construct_course.R.

• Assigned to @CChCheChen

** Create a designated branch and add useful commit messages!

• Create R file in the desired location in package
• Write docstring for milestone2
• Push to Github.com
• Have pull request approved for milestone2

(will keep adding tasks along the way till the documentation is fully completed by milestone3)

• Documentation done.
• Close issue

Write the documentation for function 2: update_grades.R.

• Assigned to @shlrley

** Create a designated branch and add useful commit messages!

• Create R file in the desired location in package
• Write docstrings for methods
• Create PR
• Have PR approved and merge branch

1. make sure column names of the grades csv file are consistent.
2. use the read_csv() rather than read.csv().

Update README file for milestone 1:

• Edit the package description section
• Add Functions section
• Add Suitability within Python Ecosystem section
• Push to Github.com
• Pull Request approved and merge to main branch

1. Write R functions @CChCheChen @yukunzGIT @shlrley
2. Write unit tests @CChCheChen @yukunzGIT @shlrley

R package checklist

• GitHub actions workflow for CI @CChCheChen
• Documentation @yukunzGIT

License checklist

• Initiate a package review request @shlrley

Other

• Submit request for review @shlrley

Write the documentation for function 1: calculate_grade.R

• Assigned to @CChCheChen

** Create a designated branch and add useful commit messages!

• Create R file in the desired location in package
• Write docstring for milestone2
• Push to Github.com
• Have pull request approved for milestone2

(will keep adding tasks along the way till the documentation is fully completed by milestone3)

• Documentation done.
• Close issue

To mention

• For construct_course.R, make the last column filled with 'NA'
• Should we use write.csv() and read.csv() or write_csv() and read_csv()?
• Paths should be relative to the test script, + make sure to import libraries in the test script (?)

• Add a Code of Conduct (usethis::use_code_of_conduct)
• Add team members to DESCRIPTION
• Add Chen's email to DESCRIPTION
• Add a CONTRIBUTING.md file (usethis::use_tidy_contributing())
• Create PR
• Have PR approved and branch merged

• Write code for load_course()
• Write code for save_course_csv()
• Write code for update_assignment_grade()
• Write 3 unittests for update_assignment_grade()
• Create PR
• Have PR approved
• Merge into main branch

• Finish code of construct_course.py
• Create unit test for construct_course function
• Create PR for approval
• Code merged to main branch

• Examine license for our project and consider whether it's what we want
• Discuss reasons in R issue
• Discuss reasons in Python issue

• Finish code of calculate_grade.py
• Create unit test for calculate_grade function
• Create PR for approval
• Code merged to main branch

Tasks (individual)

• - Create R repo (Checklist 1-3) @yukunzGIT
• - Code of Conduct, DESCRIPTION, CONTRIBUTING (Checklist 4-6) @shlrley
• - README.Rmd (Checklist 7) @CChCheChen

Tasks (everyone)

• - Write R function documentation

• Finish writing your function
• Go to root directory
• $ R
• > library(devtools)
• > library(testthat)
• > use_testthat()
• > use_test("update_grades")
  • (replace with name of script)
• Open the newly created script under tests/testthat/
• Write your 3 tests in the following format:

test_that("message", {
    expect_equal(..., ...)
})

• Paths should be relative to the test script, + make sure to import libraries in the test script (?)
• Save the unit test script
• > test()

• Open issue for R package
• Open issue for Python package