get_words: Get word counts for a date or a range of dates (called by the...

Description Usage Arguments Value Examples

View source: R/get_words.R

Description

Get word counts for a date or a range of dates (called by the shell script)

Usage

1
get_words(date = Sys.Date(), repo = getwd(), netOnly = TRUE)

Arguments

date

(optional) character vector of dates, can either be of length 1, 2, or left unspecified. If length(date)==1, then get_words returns the word counts for that particular day. If length(date)==2, then date will be treated as a range, and get_words will return all word counts for dates within that range. If date is left unspecified, then get_words will return the word counts for the current date.

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.

netOnly

(optional) logical to specify whether only net additions/modifications should be reported. Set to TRUE by default

Value

Data.frame of word counts for one date or a range of dates.

Examples

1
2
3
4
5
get_words()
get_words(date="2015-01-01")
get_words(date="2015-01-01",repo="~/repositories/project/")
get_words(date=c("2015-01-01","2015-02-20"))
get_words(date=c("2015-01-01","2015-02-20"),repo="~/repositories/project/")

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