ropensci / software-review

rOpenSci Software Peer Review.
292 stars 104 forks source link

eDNAjoint: an R package for interpreting paired environmental DNA and traditional surveys #628

Closed abigailkeller closed 7 months ago

abigailkeller commented 9 months ago

Submitting Author Name: Abigail Keller Submitting Author Github Handle: !--author1-->@abigailkeller<!--end-author1-- Repository: https://github.com/abigailkeller/eDNAjoint Submission type: Pre-submission Language: en


Version: 0.1
Maintainer: Abigail G. Keller <agkeller@berkeley.edu>
Authors@R: 
    c(person("Abigail G.", "Keller", role = c("aut", "cre"), email="agkeller@berkeley.edu"),
    person("Ryan P.", "Kelly", role = "ctb", email="rpkelly@uw.edu"))
Description: Models integrate environmental DNA (eDNA) detection data and traditional survey data to jointly estimate species catch rate. Models can be used with count data via traditional survey methods (i.e., trapping, electrofishing, visual) and replicated eDNA detection/nondetection data via polymerase chain reaction (i.e., PCR or qPCR) from multiple survey locations. Estimated parameters include probability of a false positive eDNA detection, a site-level covariates that scale the sensitivity of eDNA surveys relative to traditional surveys, and catchability coefficients for traditional gear types. Models are implemented with a Bayesian framework (Markov chain Monte Carlo) using the 'Stan' probabilistic programming language.
License: GPL-3
Encoding: UTF-8
Roxygen: list(markdown = TRUE, roclets = c ("namespace", "rd", "srr::srr_stats_roclet"))
RoxygenNote: 7.3.1
Biarch: true
Depends: 
    R (>= 3.4.0)
Imports: 
    bayestestR,
    dplyr,
    ggplot2,
    loo,
    magrittr,
    methods,
    Rcpp (>= 0.12.0),
    RcppParallel (>= 5.0.1),
    rstan (>= 2.26.23),
    rstantools (>= 2.3.1.1),
    tidyr
LinkingTo: 
    BH (>= 1.66.0),
    Rcpp (>= 0.12.0),
    RcppEigen (>= 0.3.3.3.0),
    RcppParallel (>= 5.0.1),
    rstan (>= 2.26.23),
    StanHeaders (>= 2.26.22)
SystemRequirements: GNU make
LazyData: true
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3

Scope

This package runs Bayesian statistical models written in Stan using data from paired environmental DNA (eDNA) and traditional surveys provided by a user. Additional functions support interpretation of model output.

Not yet.

The target audience is environmental science researchers or managers who want to interpret environmental DNA data but do not have experience writing and implementing custom Bayesian models.

To my knowledge, no other R package implements similar types of models. Although the R package contains additional model variations, the model was originally developed in a publication: "Tracking an invasion front with environmental DNA", led by the authors of this submission.

Yes

ldecicco-USGS commented 8 months ago

@ropensci-review-bot check srr

ropensci-review-bot commented 8 months ago

This is not an 'srr' package

ldecicco-USGS commented 8 months ago

Hi @abigailkeller I'm new to the editor process for the stats submissions, so sorry for the delay.

The stat submission guide is here: https://stats-devguide.ropensci.org/pkgdev.html

I think the next step for you is to follow the directions here: https://stats-devguide.ropensci.org/pkgdev.html#pkgdev-srr https://github.com/ropensci-review-tools/srr

The eDNAjoint would need srr results to >50% before we can move the package to a full submission.

abigailkeller commented 8 months ago

Closing issue as my package seems out of scope for statistical submissions

mpadge commented 8 months ago

Hi @abigailkeller, Mark here from the rOpenSci stats team, to politely disagree with you about your package being out of scope. Scope decisions for stats packages are pretty straightforward: If you think that your package can comply with at least half of all applicable standards - in your case General and Bayesian, then it is by definition in scope.

Please feel free to have a look through your code, documentation, and tests, check all standards you think will likely apply, and if that seems like more than half, you are very welcome to open this issue again. Then, once you've documented compliance, ask the bot to call check srr yourself. As long as that requirement is met, the submission may then proceed. Thanks :smile:

abigailkeller commented 8 months ago

Re-opened issue. I believe my package is now passing at least 55% of the general statistics and Bayesian statistics standards. Thanks!

ldecicco-USGS commented 8 months ago

@ropensci-review-bot check srr

mpadge commented 8 months ago

@abigailkeller Sorry, check results got lost due to upgrades in our system. They'll appear sometime tomorrow. Sorry for any inconvenience.

ropensci-review-bot commented 8 months ago

The following standards are missing:

General standards:

G1.5, G5.4, G5.5

Bayesian standards:

BS1.2b, BS1.2c, BS1.4, BS4.0, BS4.3, BS6.2, BS6.3

All standards must be documented prior to submission

abigailkeller commented 8 months ago

Just to add to the ropensci-review-bot: I believe the missing standards (G1.5, G5.4, G5.5,BS1.2b, BS1.2c, BS1.4, BS4.0, BS4.3, BS6.2, BS6.3) are in the .Rmd file in the vignette folder

ropensci-review-bot commented 8 months ago

The following standards are missing:

General standards:

G5.4, G5.5

All standards must be documented prior to submission

There are also 39 standards with 'srrstatsTODO' tags.

mpadge commented 8 months ago

@ldecicco-USGS That srr check by the bot should now be correct. @abigailkeller You can call srr::srr_stats_pre_submit() locally to confirm that your package will pass, and then ask the bot here to check srr when you think you've finished documenting. Sorry both for any inconvenience here.

abigailkeller commented 8 months ago

@ropensci-review-bot check srr

ropensci-review-bot commented 8 months ago

'srr' standards compliance:

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

abigailkeller commented 7 months ago

@ldecicco-USGS Is there anything I need to do to move this from a submission inquiry to a submission? Thanks!

ldecicco-USGS commented 7 months ago

Thank you @abigailkeller for this pre-submission inquiry! This package is well within our statistical scope and we'd be happy to review a full submission. So now you'll need to open a new issue for the full submission. Let me know if you have any questions.

(see issue 615 for a recent example of a submission, where the pre-submission is 614)