hw09 ready for grading

[hannahdxz]

the link to hw09

the link to the powers package

SHA: e5cce2b

[yanchaoluo]

Hi Xinzhe Dong 😃 I am happy to review your homework, and I think you did a wonderful job!

• You define and export more than one new function box_cox() and my_log().

  I am impressed that you add sensible defaults na.omit=FALSE , and use proper ifelse function to detect whether or not to remove "NAs". It is a wonderful function to handle "NAs", and I will try to add this defaults to my R packages in the future. For your "my_log" function, my_log(), you designed log function very carefully, for instance, the input value needs to be greater than or equal to 0.

• In addition, your packages pass check with no errors.

• I just have a tinny suggestion, you could use stop function validity to check for function input, for example, you could replace "return("invalid input")" to "stop("invalid input)".

• It is good tests, you use 5 test_that functions(2 success tests and 3 Failing tests ) to make sure what you wrote in R file was correct.

• You document all exported functions in "NAMESPACE".

• The README file and vignettes file in your homework 9 are very informative and clear and I can easily apply your functions. Moreover, there are many examples of each function.

• I love you added box-cox transformation graph in your README.

• I have one suggestion for your README file, maybe you could explain how to install your package. One simple way shows below.

  devtools::install_github("hannahdxz/powers")

  Thank you so much for inviting me. Overall, excellent R package and homework! 💯

[peterwhitman]

Nice job on hw09! Your package installed without any problems and your documentation made it easy to use the functions you created. Similar to the previous reviewer, I think it would have been nice to provide some directions for installation and not just initialization. The only other recommendation I can think of is that you could have given the user the ability to plot the function output vs the input vector. This is a pretty easy thing to add, and might be a nice final touch.

Overall, I'm really impressed with the package you produced!

Peter

[derekcho]

Hi @hannahdxz, here are some comments about your hw09:

Able to install properly: Yes At least one new function: Yes Used assertions to check function input: Yes Documented exported functions: Yes Includes three unit tests for each function: Yes Passes check: Yes README and vignette: Yes Reflections included: Yes

• I was able to download and install your package without any problems
• Assertions were good although some of the error messages are a bit vague (eg. “invalid input”)
• Also, inconsistent indentation in code makes it a little hard to read
• Functions are well documented with appropriate examples
• Good work on unit testing, this was well done!
• Your package includes two new functions, my_log and box_cox
• Your README file is very good with lots of descriptions although these should also go in the vignette (or perhaps go in the vignette instead)
• Nice work overall, your package runs smoothly and is well implemented

Your grade will be emailed to you at a later date.