Skip to content

Address Review Comments#40

Merged
dfkapraun merged 71 commits into
mainfrom
manuscript
Aug 15, 2025
Merged

Address Review Comments#40
dfkapraun merged 71 commits into
mainfrom
manuscript

Conversation

@tjzurlin

@tjzurlin tjzurlin commented Jul 17, 2025

Copy link
Copy Markdown
Collaborator

Action items to address:

  • Add a "LICENSE" file to the repository. [We have added a LICENSE file, but may need to remove it when we resubmit to CRAN. CRAN rules seem to disallow the inclusion of a LICENSE file when a standard license (e.g., GPL-3) is used. In such cases, CRAN requests that package authors name the standard license and that they not include a LICENSE file.]
  • Ensure all dependencies are stated in the "DESCRIPTION" file. According to one of the reviewers, stringi, DT, and htmltools are packages that are required for installation. [We believe that all packages on which MCSimMod depends are correctly listed in the DESCRIPTION file. No errors are produced in our continuous integration (CI) checks for installation of MCSimMod on Unix and Windows systems.]
  • Add link to download Rstudio-desktop to aid users. [We have not done this. We don't think it's our place to endorse a specific integrated development environment (IDE) for R.]
  • Add a vignette that provides descriptions of createModel() and compileModel(). [The new vignette 'details.Rmd' provides descriptions of createModel() and compileModel().]
  • Add a vignette that demonstrates implementation and application of a PBPK model. [The new vignette 'pbpk_demo.Rmd' describes a PBPK model implemented in the file 'pbpk_simple.model' and demonstrates how to apply it.]
  • Perhaps add a vignette that includes and Monte Carlo or Bayesian analysis. [We have not done this. Monte Carlo simulations can be accomplished in a straightforward way, and Bayesian analysis can be performed with the R package FME. We have added some statements about this to "paper.md".]
  • Add clear instructions for how users can report issues. [This is already done in the section 'Contact' of 'README.md'.]
  • Describe potential applications of GNU MCSim models beyond PBPK in the documentation. [The package vignettes already provide several examples of ODE models implemented in the MCSim model specification language. We added statements of this fact in 'README.md' and 'paper.md'.]
  • In "paper.md", explain why researchers might choose MCSimMod over existing R packages such as mrgsolve, rxode, and diffeqr. Highlight the unique features of MCSimMod. [We have now done this.]
  • In "paper.md", provide a brief explanation of PBPK modeling for non-specialists. [A brief explanation of PBPK models was already provided in the "Statement of need" section. We have also added a new vignette and a new example PBPK model specification file to the package to provide a more detailed explanation of PBPK modeling.]
  • In "paper.md", provide evidence or justification for the claim that computational time for MCSimMod is similar to that for GNU MCSim. [We do not make this claim, but do claim that "MCSim takes advantage of compiled languages (as acslX did) to perform model simulations quickly" and also claim "this system enables users to take advantage of the flexibility and post hoc data analysis capabilities of the interpreted language R while also achieving computational speeds typically associated with compiled programming languages like C and FORTRAN." These are true statements that follow from our use of ODE IVP solvers from the deSolve package in conjunction with compiled C code. See, e.g., https://tpetzoldt.github.io/deSolve-compiled/deSolve-compiled.html .]
  • In "paper.md", one of the reviewers claims that Lines 77 and 78 contain a "contradictory statement about MCSimMod being used 'for only IVP' and 'it is therefore'. Address this concern. [We have edited the relevant sentence.]
  • In "paper.md", address features of MCSim that are not incorporated into MCSimMod. [We added a new paragraph to address this.]
  • In "paper.md", address request for "probabilistic simulation functionality." [This can be accomplished in a straightforward way without incorporating new functionality into MCSimMod. We have added a new paragraph to discuss this.]
  • In "paper.md", one of the reviewers claims that the following statement on Line 42 is unclear: "this system encourages modelers to use separate files for defining models." The reviewer states: "I suggest adding the technical detail or example of use to the manuscript. This might be helpful for readers to gain more insight into this package. For reference, the ssdtools package (https://joss.theoj.org/papers/10.21105/joss.07492), which I previously reviewed, offers a good example." [We have added a statement to the paper: "Examples of model specification files and vignettes that demonstrate how to use them to perform simulations are included in the MCSimMod package." We also added two new vignettes, "details.Rmd" and "pbpk_demo.Rmd" that provide information about how to use the MCSimMod system for working with ODE models.]
  • Consider the request to "analyze the computational efficiency of MCSimMod relative to standalone MCSim or alternative software packages, such as mrgsolve." [While we agree that analyzing and comparing computational efficiency would be interesting and worthwhile, it is beyond the scope of this paper.]

@shapiromatron shapiromatron marked this pull request as ready for review August 14, 2025 22:12
Copilot AI review requested due to automatic review settings August 14, 2025 22:12

This comment was marked as outdated.

@dfkapraun dfkapraun requested a review from Copilot August 15, 2025 15:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements several review action items for the MCSimMod package, primarily focused on updating documentation and adding new demonstration content. The changes enhance the package's educational value and clarify how the software works with ODE models.

Key changes include:

  • Addition of new vignettes demonstrating package functionality and PBPK modeling
  • Updates to existing vignette numbering and cross-references for better organization
  • Addition of comprehensive documentation for paper submission including figures and bibliography

Reviewed Changes

Copilot reviewed 24 out of 57 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
vignettes/details.Rmd New vignette explaining MCSimMod details and object-oriented design
vignettes/pbpk_demo.Rmd New comprehensive PBPK model demonstration vignette
vignettes/model_specification.Rmd Enhanced model specification vignette with detailed element descriptions
inst/extdata/pbpk_simple.model New PBPK model specification file for demonstrations
paper/paper.md Complete paper submission with summary and statement of need
LICENSE Addition of GPL-3 license file
R/compileModel.R Enhanced error handling and logging messages
DESCRIPTION Version update and dependency reorganization

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Comment thread vignettes/pbpk_demo.Rmd
Comment thread vignettes/model_specification.Rmd
Comment thread vignettes/model_specification.Rmd
Comment thread vignettes/pk1_demo.Rmd Outdated
Comment thread R/compileModel.R
@dfkapraun dfkapraun merged commit 671ac03 into main Aug 15, 2025
3 checks passed
@dfkapraun dfkapraun deleted the manuscript branch August 15, 2025 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants