branch_rename {git2r} | R Documentation

## Rename a branch

### Description

Rename a branch

### Usage

    branch_rename(branch, name, force = FALSE)

    ## S4 method for signature 'git_branch'
    branch_rename(branch, name, force = FALSE)

### Arguments

`branch` | Branch to rename
`name` | The new name for the branch
`force` | Overwrite existing branch. Default is FALSE

### Value

invisible renamed S4 class git_branch

### Examples

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

    ## Config user and commit a file
    config(repo, user.name="Alice", user.email="alice@example.org")
    writeLines("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do",
               file.path(path, "example.txt"))
    add(repo, "example.txt")
    commit(repo, "First commit message")

    ## Rename 'master' branch to 'dev'
    branches(repo)
    branch_rename(head(repo), "dev")
    branches(repo)

    ## End(Not run)

[Package git2r version 0.20.0 Index]