A Case Study in Reproducible Model Building

[This article was first published on jfisher-usgs, and kindly contributed to R-bloggers]. (You can report issue about the content on this page here)
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

center

The U.S. Geological Survey (USGS) recently published a report describing a groundwater-flow model of the Wood River Valley (WRV) aquifer system.
What makes this report unique (at least in my opinion) was the authors’ desire to make their work as reproducible as possible under budgetary constraints.
The collection of raw data, source code, and processing instructions used to build and analyze the model was placed in an non-general-use R package named wrv.
The package repository can be found on GitHub.
Commands for installing the package are as follows:

<span class="n">repos</span><span class="w"> </span><span class="o"><-</span><span class="w"> </span><span class="nf">c</span><span class="p">(</span><span class="s2">"http://owi.usgs.gov/R"</span><span class="p">,</span><span class="w"> </span><span class="n">getOption</span><span class="p">(</span><span class="s2">"repos"</span><span class="p">))</span><span class="w">
</span><span class="n">install.packages</span><span class="p">(</span><span class="s2">"wrv"</span><span class="p">,</span><span class="w"> </span><span class="n">repos</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">repos</span><span class="p">,</span><span class="w"> </span><span class="n">dependencies</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">TRUE</span><span class="p">,</span><span class="w"> </span><span class="n">type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">)</span><span class="w">  </span><span class="c1"># about 100 MB, so be patient
</span>

While many of the functions are intended for non-general use, there are a few functions that the larger R community might find of interest.
For example, the PlotMap, PlotGraph, and PlotCrossSection functions have been designed for general use.
Report documentation was included in the wrv package as vignettes; these files are also available from the
USGS Publications Warehouse.
For a general overview of the project, I’ll recommend my
useR! 2016 talk:

Any comments or suggestions regarding our approach to reproducible model building can be left below.
Please realize that your opinions go a long way in determining whether this type of approach will be used in future projects.

To leave a comment for the author, please follow the link and comment on their blog: jfisher-usgs.

R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

Never miss an update!
Subscribe to R-bloggers to receive
e-mails with the latest R posts.
(You will not see this message again.)

Click here to close (This popup will not appear again)