Homework 09 is Ready for Grading

[HScheiber]

• Link to the main page of my homework repo

• Link to the homework 9 Section

• Link to the homework 9 package repo

• Link to the vignette for my package

• Install in Rstudio with devtools::install_github("HScheiber/powers").

• Last SHA: b0fef53526604fee89472cb9b118e230788f9842

[xinmiaow]

Hi @HScheiber,

It’s nice to review your package. I did not choose this task, so it’s good for me to learn from your homework.

You create the following functions in your powers Package:

Export Functions

• [X] square:
  • square of a vector (numerical, logical or character elements)
  • plot the result by ggplot (TRUE or FALSE)
  • return the results (TRUE or FALSE)
  • return the plot (TRUE or FALSE)
• [X] cube:
  • cube of a vector (numerical, logical or character elements)
  • plot the result by ggplot (TRUE or FALSE)
  • return the results (TRUE or FALSE)
  • return the plot (TRUE or FALSE)
• [X] reciprocal
  • reciprocal of a vector (numerical, logical or character elements)
  • plot the result by ggplot
  • return the results (TRUE or FALSE)
  • return the plot (TRUE or FALSE)
• [X] pwr
  • can change the power
  • return the results (TRUE or FALSE)
  • return the plot (TRUE or FALSE)

Each function is documented and has the corresponding test file. It’s really nice you deal with characters and strings. In addition, you create the arguments returnVal and returnPlot choose whether the output will be returned.

Internal Functions

• [X] pow
  • calculate the power of a vector (numerical, logical or character elements)
  • plot the result

Other files:

• [X] README file
• [X] Vignettes file
  • I found the pdf version
  • however, there is no Vignettes folder in your repo
• [X] Description
  • Import ggplot, stringr

Overall, I think you did good job.

[bcahn7]

Hello @HScheiber , Here are some comments on your hw09. Hope it helps!

• It was good to warn that your package will overwrite any other package named powers

• Your vignettes and README are informative about the package and the functions in it.

• I did not know how to put @seealso in powers-documentation.R. It was good to know! It would be useful to show all the functions in it and convenient!

• pow()

  • This internal function avoids all the redundancy for all external functions.
  • You really considered all the details using if-else statements to avoid warnings or errors. They were impressive!
  • You have if statements to make sure that all the values on arguments are logical for Plot_it, returnVal, and returnPlot
  • You imported two packages: stringr and ggplot2.

• pwr(), square(), cube(), reciprocal()

  • It was impressive to have characters as input and the output is designed to repeat it. When a = 0, the output prints out the first letter of the input string.
  • Each function is documented well. They are informative!
  • You have at least 5 unit tests for every function that is exported (with expectation for success and failure.

Overall, I think you have a thorough understanding on building your own R packages. You did a great job!