ropensci / software-review

rOpenSci Software Peer Review.
286 stars 104 forks source link

Presubmission inquiry: dynamite - Bayesian Modeling and Causal Inference for Multivariate Longitudinal Data #552

Closed santikka closed 1 year ago

santikka commented 1 year ago

Submitting Author Name: Santtu Tikka Submitting Author Github Handle: !--author1-->@santikka<!--end-author1-- Other Package Authors Github handles: !--author-others-->@helske<!--end-author-others-- Repository: https://github.com/santikka/dynamite Submission type: Pre-submission Language: en


Package: dynamite
Title: Bayesian Modeling and Causal Inference for Multivariate
    Longitudinal Data
Version: 0.0.1
Authors@R: c(
    person("Santtu", "Tikka", , "santtuth@gmail.com", role = c("aut", "cre"),
           comment = c(ORCID = "0000-0003-4039-4342")),
    person("Jouni", "Helske", , "jouni.helske@iki.fi", role = "aut",
           comment = c(ORCID = "0000-0001-7130-793X"))
  )
Description: Easy-to-use and efficient interface for 
  Bayesian inference of complex panel (time series) data. The package supports 
  joint modeling of multiple measurements per individual, time-varying and
  time-invariant effects, and a wide range of discrete and 
  continuous distributions. Estimation of the models is carried out via 'Stan'.
License: GPL (>= 3)
URL: https://github.com/santikka/dynamite
BugReports: https://github.com/santikka/dynamite/issues
Depends: 
    R (>= 4.1.0)
Imports: 
    bayesplot,
    checkmate,
    cli,
    data.table (>= 1.14.3),
    dplyr,
    glue,
    ggplot2,
    MASS,
    posterior,
    rlang,
    rstan (>= 2.26.11),
    stats,
    tidyr,
    utils
Suggests: 
    covr,
    knitr,
    plm,
    rmarkdown,
    testthat (>= 3.0.0)
VignetteBuilder: 
    knitr
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE, roclets = c ("namespace", "rd",
    "srr::srr_stats_roclet"))
RoxygenNote: 7.2.1
LazyData: true
LazyDataCompression: xz

Scope

The package performs multivariate bayesian regression modeling for panel data (multiple individuals measured over time). Model estimation is carried out via Stan.

Yes.

The package is mainly intended for applied researchers working with complex panel data. Panel data is common in many scientific fields, especially in sociology and econometrics. For example, analysing individual-level life-course data is valuable for assessing the effects of policy reforms and other interventions.

Several approaches and R packages exist for panel data analysis, that share some common features with dynamite, which we have listed in the package README along with the full feature suite of the package. However, we found that other packages often fall short in crucial aspects, such as only supporting gaussian responses, univariate data or effects constant over time and are thus applicable only in specific constrained scenarios. To the best of our knowledge, there are no other R packages (or software in general) that support all features of dynamite simultaneously.

Yes.

Regarding the standards, G1.0 states that:

"G1.0 Statistical Software should list at least one primary reference from published academic literature."

While we certainly have several references in the package vignette, our plan is to also write two scientific papers ourselves: a methodological paper that would serve as the primary reference, and a software paper focusing on the dynamite package (possibly in the Journal of Statistical Software). Would it be an issue that this "primary reference" does not yet exist at the review stage?

adamhsparks commented 1 year ago

Hi @santikka, In reference to your query about the publication requirement. If I understand your inquiry correctly, you have several references for the methods that you are using in the package but this package is the first to combine them, is this correct?

santikka commented 1 year ago

Hi @adamhsparks, Yes, that is correct.

adamhsparks commented 1 year ago

That’s fine. If you have those references for the methods then we can accept your submission.

santikka commented 1 year ago

Hi @adamhsparks, Please let me know if there is anything I can do to move this inquiry forward. Should I provide the references mentioned here?

adamhsparks commented 1 year ago

Hi @santikka, I've updated the label on this just for clarity. I had missed that we actually have a "0/presubmission" label.

To move forward, please open a new issue with your submission.

I am closing this now and look forward to your submission.

santikka commented 1 year ago

Thanks @adamhsparks! I will be submitting the package very soon.