R/plot_words.R

In tcspears/gitwords: Tools for tracking word counts of commits made to git repositories.

#' Function to builds plots (called by the shell script)
#' 
#' @param date (optional) character vector of dates, can either be of length 1, 2, or left unspecified. If length(date)==1, then the plots will include all commits from that day until the latest commit. If length(date)==2, then date will be treated as a range, and the plot will include all commits within that range. If date is left unspecified, then the plot will include all commits in the repository.
#' @param repo (optional) character string giving the relative or absolute path to the git repository. If left unspecified, the current working directory will be used as the repo.
#' @param metric (optional) Character string indicating which word count measure should be plotted. Acceptable options are "net" (net additions and modifications) and "nd" (new and deleted)
#' @param tofile (optional) logical specifying whether the plot should be written to a pdf file (instead of displayed interactively)
#' @examples
#' plot_words()
#' plot_words(date="2015-01-01")
#' plot_words(date="2015-01-01",repo="~/repositories/project/")
#' plot_words(date=c("2015-01-01","2015-02-20"))
#' plot_words(date=c("2015-01-01","2015-02-20"),repo="~/repositories/project/")

plot_words <- function(date=NULL,repo=getwd(),metric="net",tofile=FALSE){
  a <- extract_commits(repo)
  a <- drop_interday(a)
  b <- NULL
  if(is.null(date)){
    b <- a
  } else if(length(date)==1){
    upper.date <- as.character(as.Date(a[order(as.Date(a$Date),decreasing=TRUE),][1,2]))
    lower.date <- date
    b <- subset_commits_date(commit.table=a,date=c(lower.date,upper.date))
  } else {
    b <- subset_commits_date(commit.table=a,date=date)
  }
  c <- add_word_counts_table(b,repo)
  d <- collapse_date(c)
  if(tofile==FALSE){
    build_plots(d,metric=metric)
  } else {
    if(substr(repo,nchar(repo),nchar(repo))=="/"){
      pdf(file=paste(repo,"wordplot.pdf",sep=""))
      build_plots(d,metric=metric)
      dev.off()
      cat("Plot saved as wordplot.pdf within ",repo,"\n")
    } else {
      pdf(file=paste(repo,"/wordplot.pdf",sep=""))
      build_plots(d,metric=metric)
      dev.off()
      cat("Plot saved as wordplot.pdf within ",repo,"\n")
    }
  }
}