git.repo: Git Repo

View source: R/git.repo.R

git.repoR Documentation

Git Repo

Description

Read the Git repository name from the .git folder.

Usage

git.repo(path = ".", owner = FALSE, warn = FALSE)

Arguments

path

top directory of a Git repository.

owner

whether to include the repository owner name.

warn

whether to generate a warning if no ⁠.git/config⁠ file is found.

Value

String of the format "[owner]/repo".

See Also

draft.readme calls git.repo to include the repository name in the ⁠README.md⁠.

TAF-package gives an overview of the package.

Examples

## Not run: 
git.repo()
git.repo(owner=TRUE)

## End(Not run)


ices-tools-prod/TAF documentation built on April 17, 2025, 2:02 p.m.