Assignment B-1 Feedback

[albina23]

Hi Kai,

Great work on your Assignment B-1! Please see a few comments below that will help you improve your function for the next submission:

• Tidy submission: Clear and well-written README.md file, reproducible code, good use of a release. You should be suppressing the messages when loading libraries by adding suppressPackageStartupMessages() around your library commands. You also needed to knit your .Rmd file as a github_document (not html_document) and upload the knitted .md file to your repo. Code on lines 10-16 should be removed as it is the default text provided on all new .Rmd files. Lines 39 to 55 should have been placed inside a code chunk.
• Ex 1: Clearly well-written function. You need to include an if-stop statement to make sure your x variable is either character or factor.
• Ex 2: Great documentation.
  • @title is not a roxygen2 tag, the title and description are usually written like this:
    #' This is the title. #' #' This is the description. (or you can use the @description tag) #' #' These are further details. (you can use @details tag) #' #' @param x description here
  • Use @param instead of @params in the documentation (small error but would give you trouble when creating the package for B-2!).
• Ex 3: Good use of penguins dataset to illustrate your function. However, the assignment has asked to include a few (i.e. at least 2) examples here.
• Ex 4: Great demonstration of test_that() function. I don't understand why you needed to create three new functions (Data_overview_maxmin, Data_overview_mean, Data_overview_Stdev) when doing testing - all your tests should be applied to your one function Data_overview. If you needed to get information on maxmin, mean, and stdev, you could have extracted it from the generated table.

Overall, the function looks great - keep up the good work! Please let me know if you have any questions. Grades will be posted soon on Canvas.

Best,
Albina