dsidavis/RCleanProject: Analyze Code in Scripts to Query and Display Code Content, Identify Dependencies, Orphans, ...

Understanding code one inherits, or what files, functions and scripts are actually used in your own slowly evolving project can be very useful. To create a minimal set of data files, code files, functions, plots, etc. so that others can reproduce your work is necessary for enabling reviewers (journal or code) to efficiently understand the code. This package also helps people become familiar with other people's code. This currently works on scripts but is very easily adapted to Sweave, XML, Markdown, knitr, JSS, iPython/Jupyter documents. This uses static analysis to understand the dependencies. We can find filenames with absolute paths and then convert these to relative paths. We can identify the names of "plot files" and then ensure these are up-to-date and compute these with minimal computation. We plan on extending this to shell scripts, understanding Makefiles, and also programmatically generating Makefiles from the dependencies.

Getting started

Package details

AuthorMatt Espe Duncan Temple Lang
MaintainerDuncan Temple Lang <[email protected]>
LicenseBSD_3_Clause + LICENSE
Version0.1-0
Package repositoryView on GitHub
Installation Install the latest version of this package by entering the following in R:
install.packages("remotes")
remotes::install_github("dsidavis/RCleanProject")
dsidavis/RCleanProject documentation built on May 15, 2019, 4:19 p.m.