JOSS Review - Functionality and Documentation
General comment: In my opinion it would be worth tidying up the package and submitting to CRAN. This would likely result in greater usage.
Installation
-
Current link to OGS on the r2ogs6 repository points to https://www.opengeosys.org/releases/. Would be better pointing to https://www.opengeosys.org/docs/userguide/basics/introduction/ which outlines the installation options rather then just giving downloads -
Cloning the r2ogs6 repository and used devtools::install does not pick up and install BiocManager or rhdf5 so fails. These (perhaps only rhdf5?) need to be installed first. The sequence in the instructions need altering to reflect this. -
Be explicit about getting the user to note where the OGS executables are installed. Not clear to me about how this would work with containers but didn't try this.
Statement of Need
-
This is missing from the documentation
Examples
Single Simulation
-
Would be helpful if the line "Since I already read in a .prj file earlier, I won't run the above snippet.2 was above the code block :) -
Working with hdf5 files currently states "Here, we have added a file artificially from the benchmark library for demonstration." - a minimal data set (or clear link to one) should be included (is not one also needed for testing?)
Ensemble Simulations
-
Include options("r2ogs6.default_ogs6_bin_path" = "<already_noted_path_from installation>")
in the preamble code -
These take a long time to run for examples, perhaps consider trimming them or stating run time estimates
Community Guidelines
-
While it is possible that "We are happy about all contributions!" I (hope) that there are some that you might not be happy with - reflect this! -
Should note that sign-up to the opengeosys gitlab is required to raise issues etc. Maybe this barrier is to high?