Open CassKon opened 6 years ago
Peer Review:
Hi! @CassKon I think you did a great job on your homework09. I downloaded your package and tried to use it. Your package is easy to use and has several additional functions includingregress()
,diff()
. All basic elements are contained in your package and no obvious technical errors.
All the functions are created by basic operations and your package also importslm
function fromstat
. I think yourpower
package meets the requirements of this assignment and it is simple to understand.
You did a really good unit tests for every function including expectation for success and two for errors. Actually you can separate it into different R scripts if you want because sometimes one package may contain many functions, then only one script is not enough, but it doesn't matter in your package.
A small suggestion is that it is better to add some information aboutInstallation
like below into yourREADME.md
. In my opinion,README.md
should include general description, Usage and Installation about the package as it will be read by different users.
devtools::install_github("CassKon/power")
I can review your vignette.html because I have downloaded your repo. Actually You can also render your .rmd file into .md file in order to help people review your homework quickly.
Overall, I think your homework was well done and hope you can keep it up!
Regards, Jiahui Tang
Hey Cassandra,
I couldn't get your package working but the review above mine did, so I'm going to assume it's something silly on my end.
Your repo is well organized with clear links to the relevant materials. I can't really think of much else to say that hasn't been covered by the reviewer before me - it would be nice to have explicit installation instructions for the package. Your examples are clear and easy to follow. The code seems well written, with error/sanity checks in the functions. There are numerous examples in the tests. The vignette doesn't show the output but I had this exact same problem and couldn't figure it out.
Good job, hope your next term goes well!
My assignment can be found here!