R/get_project_info.R

In adapr: Implementation of an Accountable Data Analysis Process

#' Acquire all dependencies related to a project,
#' Generate graph of project dependencies,
#' Get all file information related to project
#' 
#' @param dependency.dir is the string location of dependency files
#' @return list with stacked dependency files, graph of dependencies, and condensed file information
#' @export
#' @examples 
#'\dontrun{
#' projInfo <- getProjectInfo(pullSourceInfo("adaprHome")$dependency.dir)
#' plot(projInfo$graph) 
#'} 
#' 
getProjectInfo <- function(dependency.dir){
  
  # get project object
  
  trees <- readDependency(dependency.dir)
  
  g.all <- makeSummaryGraph(dependency.dir=NULL,dependency.object=trees,plot.graph=FALSE)
  
  file.info.object <- condenseFileInfo(trees)
  
  return(list("tree"=trees,"graph"=g.all,"all.files"=file.info.object))
  
}