reproducible packageBuilt on top of git2r and archivist, this package aims at making high-level, robust, machine and OS independent tools for making deeply reproducible and reusable content in R. This extends beyond the package management utilities of packrat and checkpoint by including tools for caching, and accessing GitHub repositories.
There are many elements within the reproducible package. However, there are currently
3 main ones that are critical for reproducible research. The key element for reproducible
research is that the code must always return the same content every time it is run,
but it must be vastly faster the 2nd, 3rd, 4th etc, time it is run. That way, the entire
code sequence for a project of arbitrary size can be run from the start every time.
| Function | Objective |
Cache |
A robust wrapper for any function, including those
with environments, disk-backed storage (currently on Raster)
class), operating-system independent, whose first time
called will execute the function, 2nd time will compare the inputs
to a an SQLite database of entries, and recover the first result
if inputs are identical. If options("reproducible.useMemoise" = TRUE),
the third time will be very fast as it will recover the answer from
RAM |
prepInputs |
A function to download, or load objects, and possible post process
them. The main advantage to using this over more direct routes is
that it will automatically build checksums tables, use Cache
internally where helpful, and possibly run a variety of post processing
actions. This means this function can also itself be cached for even
more speed. This allows all project data to be stored in custom cloud
locations or in their original online data repositories,
without altering code between the first, second, third etc. times
the code is run. |
Require |
A version of require that incorporates elements of
install.packages, devtools::install_github, packrat.
It allows for users code to work for a new user on a new machine that
may or may not have all packages installed. |
Function |
See reproducibleOptions for a complete description of package
options to configure behaviour.
Useful links: