git_report: Report on Git Repository Status

In sjpierce/piercer: Functions for Research and Statistical Computing

Report on Git Repository Status

Description

This function produces a short report about whether the current file is located in a Git repository and, if so, what commit it is at, and the status of the repository.

Usage

git_report(path = here())

Arguments

path	A character value containing the path to a folder containing a git repository, defaulting to the result of here::here().

Details

This function facilitates concisely adding version control output to report scripts. It is basically a wrapper that calls git2r::repository() and git2r::status() after verifying that you are in a Git repository.

Value

A data frame.

Examples

git_report()

sjpierce/piercer documentation built on Dec. 30, 2024, 3:28 p.m.