supporting the executability of r markdown files
abstract
r markdown files are examples of literate programming documents that combine r code
with results and explanations. such dynamic documents are designed to execute easily and
reproduce study results. however, little is known about the executability of r markdown
files which can cause frustration among its users who intend to reuse the document. this
thesis aims to understand the executability of r markdown files and improve the current
state of supporting the executability of those files.
towards this direction, a large-scale study has been conducted on the executability of
r markdown files collected from github repositories. results from the study show that a
significant number of r markdown files (64.95%) are not executable, even after our best
efforts. to better understand the challenges, the exceptions encountered while executing
the files are categorized into different categories and a classifier is developed to determine
which markdown files are likely to be executable. such a classifier can be utilized by search
engines in their ranking which helps developers to find literate programming documents as
learning resources. to support the executability of r markdown files a command-line tool
is developed. such a tool can find issues in r markdown files that prevent the executability
of those files. using an r markdown file as an input, the tool generates an intuitive list
of outputs that assist developers in identifying areas that require attention to ensure the
executability of the file. the tool not only utilizes static analysis of source code but also uses
a carefully crafted knowledge base of package dependencies to generate version constraints
of involved packages and a satisfiability modulo theories (smt) solver (i.e., z3) to identify
compatible versions of those packages. findings from this research can help developers
reuse r markdown files easily, thus improving the productivity of developers. [...]