getGitInfo: Get git repository information for a script

Description Usage Arguments Details Examples

View source: R/getGitInfo.R

Description

getGitInfo locates the git repository for the calling script (if any) and retrieves relevant informaiton such as last commit, status (e.g. modified since last commit) and tag (if any).

Usage

1
getGitInfo(scriptpath = NA)

Arguments

scriptpath

Path to script (optional, defaults to calling script from get_scriptPath())

Details

Requires that git2r be installed.

Examples

1
git_info <- getGitInfo()

envDocument documentation built on Sept. 19, 2017, 9:02 a.m.