plot_words: Function to builds plots (called by the shell script)

Description Usage Arguments Examples

View source: R/plot_words.R

Description

Function to builds plots (called by the shell script)

Usage

1
plot_words(date = NULL, repo = getwd(), metric = "net", tofile = FALSE)

Arguments

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.

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.

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)

tofile

(optional) logical specifying whether the plot should be written to a pdf file (instead of displayed interactively)

Examples

1
2
3
4
5
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/")

tcspears/gitwords documentation built on June 9, 2021, 1:34 a.m.