git2r (version 0.7)

status: Status

Description

Display state of the repository working directory and the staging area.

Usage

status(repo, staged = TRUE, unstaged = TRUE, untracked = TRUE,
  ignored = FALSE, verbose = TRUE)
## S3 method for class 'git_repository':
status(repo, staged = TRUE, unstaged = TRUE,
  untracked = TRUE, ignored = FALSE, verbose = TRUE)

Arguments

repo

The git_repository to get status from.

staged

Include staged files. Default TRUE.

unstaged

Include unstaged files. Default TRUE.

untracked

Include untracked files. Default TRUE.

ignored

Include ignored files. Default FALSE.

verbose

Display status. Default TRUE.

Value

• invisible(list) with repository status

Examples

## Initialize a repository
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)

## Config user
config(repo, user.name="Alice", user.email="[e-mail]")

## Create a file
writeLines("Hello world!", file.path(path, "test.txt"))

## Check status; untracked file
status(repo)

## Add file
add(repo, "test.txt")

## Check status; staged file
status(repo)

## Commit
commit(repo, "First commit message")

## Check status; clean
status(repo)

## Change the file
writeLines(c("Hello again!", "Here is a second line", "And a third"),
           file.path(path, "test.txt"))

## Check status; unstaged file
status(repo)

## Add file and commit
add(repo, "test.txt")
commit(repo, "Second commit message")

## Check status; clean
status(repo)