Open vmichalowski opened 6 years ago
Dear @vmichalowski,
Good job on homework 9. I was able to install you package successfully and it worked fine. Here are few of my comments.
Define and export at least one new function: You have written scripts for three additional functions (apart from the ones discussed in class) in your package.
Give function arguments sensible defaults: not applicable
Use assertions to add some validity checks of function input: No. Functions dont have validity checks to ensure the input is a number. It would have been nice to add some inbuilt validity functions for this purpose. You have general documentation accessible with help(powersexpanded) and a general package vignette accessible (using_powersexpanded).Document all exported functions: yes, functions are documented.
Include at least three unit tests for every function that is exported. There should be at least one expectation for success and one for failure: in the tests/testthat folder, scripts for testing functions are available: test_cubert.R, test_squarert.R. Multiple test functions are written in each file to account for different possible cases.
Keep updating the README and vignette to show usage of all the functions in the package: the README is clear but it would have been nice if more examples were provided. Push your package to GitHub, preferably a public repo: yes, this has been completed !
Write your reflections in a document: yes, You have mentioned the difficulties you faced and the resources that helped you in the report your process part.
Overall, writing a package is a difficult task and you have done a great job in implementing it.
Regards, abishekarun
Hi Victoria: I think you did a good job completing this assignment! My comments are below: • Package installation: worked fine • Define and export at least one new function: You expanded the package we developed in class and created two new functions: squarert and cubert • Give function arguments sensible defaults: I didn’t identify any. Maybe you could have included a plot as we did in class and use a sensible default for that. • You didn’t include assertions to add some validity checks of function input • All exported functions are documented and you have a vignette. • You included at least three unit tests for every function that is exported. • You wrote your reflections in a document.
Overall, I think you did a great your with your package! Best,
Mar
@vincenzocoia @gvdr @ksedivyhaley @JoeyBernhardt @mynamedaike @pgonzaleze @derekcho
Here is a link to the readme.md for my package, which has instructions for installation and usage.
And here is a link to my process report.