stat545ubc-2021 / functions-jiangsissi720 Goto Github PK

Hey Qianhui,

Awesome work for Assignment B-1! 🎉 A few comments below, please let me know if you have any questions:

Tidy Submission

• Tagged a release but you didn't submit the link to the release on Canvas (https://github.com/stat545ubc-2021/functions-Jiangsissi720/releases/tag/assignment1) - make sure to do that for B-2!

• README too bare, you should add what each file in the repo contains and how to run the code (see minimal requirements for any README under ""Exercise 7"" here: https://stat545.stat.ubc.ca/collaborative-project/milestone1/)

• You completed all the requirements for the assignment, but some of your answers are out of place - for example, your function description and argument descriptions should be in the same code chunk as your function, instead of in the R Markdown, like this:

#' Splits strings with the possibility to split and keep the delimiter after or before the given split, or it can help to split between two given splits and keep both.

#' @param x A character vector, each element of which is to be split. Other inputs, including a factor, will give an error.

#' @param split A character vector (or object which can be coerced to such) containing regular expression(s) to use for splitting. If empty matches occur, in particular if split has length 0, x is split into single characters. If split has length greater than 1, it is recycled along x.

#' @param type A character. Either to remove or keep the delimiter before, between or remove the split.

and so on with all of your arguments. As a result, you lost some points from Exercise 2 and from your reproducibility/organization.

Exercise 1

Try to write more comments with your code for the function, it is a pretty complex function and if anyone is going through your code it would be useful to have some comments indicating what the code is doing!

Everything else is perfect!

Thanks,
Icíar

Hey Qianhui,

Congratulations on successfully finishing STAT545B and your last assignment! You did an excellent job ✨ A ✅ indicates that there is no detailed feedback to provide, as everything in regards to that assignment component was perfect! Please see detailed feedback for Assignment B4 below:

Tidy Submission ✅

Structure and functionality:

• DESCRIPTION file does not have updated package title (just says "What the package does (One line, Title case)")

Code mastery ✅

Package design:

• No vignette present
• No pkgdown website present

Goals of Option B for Assignment B4 were:

• Make more functions and tests, and update relevant documentation.
• Make a vignette.
• Make a package website (use pkgdown, and activate it with GitHub Pages if your repository is public.

Package development ✅

I hope that you enjoyed taking this course, and please don't hesitate to reach out if you have any questions, whether about the assignment specifically or the course in general!

Thanks,
Icíar

Hey Qianhui,

Excellent work! 🎉 Please see feedback below, and let me know if you have any questions!

• installation instructions in README are a bit confusing, devtools::install_github(""stat545ubc-2021/functions-Jiangsissi720"") is correct, but `install.packages("StrSplitP") won't work because the package is not on CRAN!

Other than that, everything looks perfect! I can see that you put a lot of effort into the package - great job!

Thank you,
Icíar