R/code_graph.R

In ProvTools/Rclean: A Tool for Writing Cleaner, More Transparent Code

# This file is part of Rclean
#
# Rclean is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# Rclean is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Rclean; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# Contact: Matthew Lau <matthewklau@fas.harvard.edu>

#'code_graph --- A network diagram of computational dependencies. 
#'
#' Plot the dependencies among functions and objects for a given script.
#' 
#'@param script Script object from CodeDepends or a file path to a script.
#'@param pdf_file Path to output PDF of the code graph.  
#'@return A network plot.
#'@importFrom igraph graph_from_adjacency_matrix
#'@importFrom igraph igraph.to.graphNEL
#'@importFrom Rgraphviz plot
#'@importFrom grDevices pdf
#'@importFrom grDevices dev.off
#'@export code_graph
#'@author Matthew K. Lau
#'@examples
#'\dontrun{
#' script <- system.file("example", "simple_script.R", package = "Rclean")
#' simple.script <- readScript(script)
#' code_graph(simple.script)
#'}

code_graph <- function(script, pdf_file) {
    if (class(script) == "character") {
        src <- readScript(script[1])
    }else if (class(script) == "Script") {
        src <- script
    }
    g <- var_lineage(src)[["g"]]
    ig <- graph_from_adjacency_matrix(g)
    gn <- igraph.to.graphNEL(ig)
    if (missing(pdf_file)) {
        plot(gn)    
    } else {
        pdf(pdf_file)
        plot(gn)
        dev.off()
    }
}