search

JMSLab / eventstudyr

Other
24 stars 1 forks source link

Discussion of including code coverage #15

Closed nateschor closed 1 year ago

nateschor commented 1 year ago

Many R packages have a code coverage tag that tells users the % of code that is covered by unit tests. As a user, I feel more comfortable using a package if I see that it has been thorough tested and code coverage % is a quick measure of that.

dplyr and ggplot2 are two examples of packages that report code coverage

The covr package seems to be the most common package for setting up code coverage and requires little set up work on our end

Please share any thoughts here, thanks!

image

jmshapir commented 1 year ago

@nateschor thanks for suggesting this!

My take is that this is a nice idea but also something we can live without for the first release. Along the lines of https://github.com/JMSLab/eventstudyr/issues/17#issuecomment-1405021130 I think we should prioritize the features and documentation we really need for first release, and keep the rest on a post-release feature list on the roadmap.

jmshapir commented 1 year ago

@nateschor should we close this issue for now and plan to reopen once the package is live?

nateschor commented 1 year ago

@nateschor should we close this issue for now and plan to reopen once the package is live?

@jmshapir sounds good to me! I added it to the Roadmap