git_report: Report on Git Repository Status
In sjpierce/SSACHR: Serial Sexual Assault Study Criminal History Records Paper Research Compendium
Description
Usage
Arguments
Details
Value
Examples
View source: R/Utility_Functions.R
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
1
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
1
sjpierce/SSACHR documentation built on Jan. 16, 2022, 12:39 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value Examples
View source: R/Utility_Functions.R
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
1 | 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
1 |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.