ropensci / software-review

rOpenSci Software Peer Review.
286 stars 104 forks source link

Presubmission inquiry - predictNMB: Evaluate Clinical Prediction Models by Net Monetary Benefit #564

Closed RWParsons closed 1 year ago

RWParsons commented 1 year ago

Submitting Author Name: Rex Parsons Submitting Author Github Handle: !--author1-->@RWParsons<!--end-author1-- Other Package Authors Github handles: @robinblythe, @agbarnett Repository: https://github.com/RWParsons/predictNMB Submission type: Pre-submission Language: en


Package: predictNMB
Type: Package
Title: Evaluate Clinical Prediction Models by Net Monetary Benefit
Version: 0.0.0.9000
Authors@R: c(
    person("Rex", "Parsons", role = c("aut", "cre"),
           email = "rex.parsons94@gmail.com",
           comment = c(ORCID = "0000-0002-6053-8174")),
    person("Robin", "Blythe", role = "aut",
           comment = c(ORCID = "0000-0002-3643-4332")),
    person("Adrian", "Barnett", role = "aut",
           comment = c(ORCID = "0000-0001-6339-0374")),
    person("Susanna", "Cramb", role = "ctb",
           comment = c(ORCID = "0000-0001-9041-9531")),
    person("Steve", "McPhail", role = "ctb",
           comment = c(ORCID = "0000-0002-1463-662X"))
  )
Description: Estimates when and where a model-guided treatment strategy may outperform 
    a treat-all or treat-none approach by Monte Carlo simulation and evaluation of the Net Monetary Benefit (NMB).
License: GPL (>= 3)
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.2.1
Imports: 
    assertthat,
    cutpointr,
    dplyr,
    ggplot2,
    magrittr,
    pmsampsize,
    rlang,
    stats,
    tibble,
    tidyr
Suggests: 
    flextable,
    knitr,
    parallel,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
URL: https://rwparsons.github.io/predictNMB/
BugReports: https://github.com/rwparsons/predictNMB/issues

Scope

annakrystalli commented 1 year ago

@ropensci-review-bot check srr

ropensci-review-bot commented 1 year ago

This is not an 'srr' package

annakrystalli commented 1 year ago

Hello @RWParsons šŸ‘‹

Many thanks for your pre-submission enquiry!

The editorial team has concluded that the package definitely fits in our "stats" scope.

To confirm everything is okay however, before moving to full submission, we do suggest going through the formal process of documenting compliance with the stats standards. Although you've stated that standards have been documented, the srr check indicates that they have not. It would be great if you could complete them to ensure submission would be accepted.

You can call @ropensci-review-bot check srr yourself in this issue at any time to confirm documentation has been completed successfully. You can find more details in our documentation.

Any questions, just let me know!

RWParsons commented 1 year ago

Hi @annakrystalli! Thanks for the quick response and sorry for the rookie mistake. I've updated the documentation for srr but currently only for the general stats requirements. I know you said it fits within the stats scope but I'm just wondering whether that'd be within the "Bayesian and Monte Carlo Routines" subsection or whether it's better suited elsewhere (maybe "EDA" instead just based on the standards included?).

annakrystalli commented 1 year ago

Hello @RWParsons, good question.

This is where the act of documenting against standards can be helpful in narrowing down the category. The stats-devguide states categories are appropriate where at least half of all standards can be applied. Given that and your efforts to add the standard documentation, have they made you lean more towards one or the other categories? Would atleast half the Bayesian & Monte Carlo routines standards apply?

RWParsons commented 1 year ago

Thanks for the quick response and advice @annakrystalli ! I've just tallied up how many would be NA for the Bayesian and the EDA standards and I don't make the cut for the Bayesian standards (only get about 1/3 to be relevant) but I do for the EDA (29/34 standards are relevant).

I'll make the changes to the package and document the EDA standards throughout before calling the srr checker bot.

Thanks!

RWParsons commented 1 year ago

@ropensci-review-bot check srr

ropensci-review-bot commented 1 year ago

I'm sorry @RWParsons, I'm afraid I can't do that. That's something only editors are allowed to do.

annakrystalli commented 1 year ago

Ooops! Sorry about that @RWParsons . I think you should be able to run that command so will double check with our both developers. In any case, I'll run it for you. :)

annakrystalli commented 1 year ago

@ropensci-review-bot check srr

ropensci-review-bot commented 1 year ago

'srr' standards compliance:

:heavy_check_mark: This package complies with > 50% of all standads and may be submitted.

annakrystalli commented 1 year ago

šŸŽ‰ Nice work @RWParsons ! Your package is effectively ready for submission whenever you are.