R: Check if branch is head

is_head {git2r} | R Documentation

## Check if branch is head

### Description

Check if branch is head

### Usage

    is_head(branch)

    ## S4 method for signature 'git_branch'
    is_head(branch)

### Arguments

`branch` | The branch `object` to check if it's head

### Value

TRUE if branch is head, else FALSE

### Examples

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

    ## Create a user and commit a file
    config(repo, user.name="Alice", user.email="alice@example.org")
    writeLines("Hello world!", file.path(path, "example.txt"))
    add(repo, "example.txt")
    commit(repo, "First commit message")

    ## List branches
    branches(repo)

    ## Check that 'master' is_head
    master <- branches(repo)[[1]]
    is_head(master)

    ## Create and checkout 'dev' branch
    checkout(repo, "dev", create = TRUE)

    ## List branches
    branches(repo)

    ## Check that 'master' is no longer head
    is_head(master)

    ## End(Not run)

[Package git2r version 0.21.0 Index]