# Provides Access to Git Repositories

## Documentation for package ‘git2r’ version 0.30.1

- DESCRIPTION file.

## Help Pages

A B C D F G H I L M N O P R S T W misc

## -- A --

add | Add file(s) to index
ahead_behind | Ahead Behind
as.character.git_time | Time
as.data.frame.git_repository | Coerce Git repository to a 'data.frame'
as.data.frame.git_tree | Coerce entries in a git_tree to a 'data.frame'
as.list.git_tree | Coerce entries in a git_tree to a list of entry objects
as.POSIXct.git_time | Time

## -- B --

blame | Get blame for file
blob_create | Create blob from file on disk
branches | Branches
branch_create | Create a branch
branch_delete | Delete a branch
branch_get_upstream | Get remote tracking branch
branch_remote_name | Remote name of a branch
branch_remote_url | Remote url of a branch
branch_rename | Rename a branch
branch_set_upstream | Set remote tracking branch
branch_target | Get target (sha) pointed to by a branch
bundle_r_package | Bundle bare repo of package

## -- C --

checkout | Checkout
clone | Clone a remote repository
commit | Commit
commits | Commits
config | Config
content | Content of blob
contributions | Contributions
cred_env | Create a new environmental credential object
cred_ssh_key | Create a new passphrase-protected ssh key credential object
cred_token | Create a new personal access token credential object
cred_user_pass | Create a new plain-text username and password credential object

## -- D --

default_signature | Get the signature
descendant_of | Descendant
diff.git_repository | Changes between commits, trees, working tree, etc.
diff.git_tree | Changes between commits, trees, working tree, etc.
discover_repository | Find path to repository for any file

## -- F --

fetch | Fetch new data and update tips
fetch_heads | Get updated heads during the last fetch.
format.git_time | Time

## -- G --

git2r | git2r: R bindings to the libgit2 library
git_config_files | Locate the path to configuration files
git_time | Time

## -- H --

hash | Determine the sha from a blob string
hashfile | Determine the sha from a blob in a file
head.git_repository | Get HEAD for a repository

## -- I --

index_remove_bypath | Remove an index entry corresponding to a file on disk
init | Init a repository
in_repository | Determine if a directory is in a git repository
is_bare | Check if repository is bare
is_binary | Is blob binary
is_blob | Check if object is S3 class git_blob
is_branch | Check if object is 'git_branch'
is_commit | Check if object is a git_commit object
is_detached | Check if HEAD of repository is detached
is_empty | Check if repository is empty
is_head | Check if branch is head
is_local | Check if branch is local
is_merge | Is merge
is_shallow | Determine if the repository is a shallow clone
is_tag | Check if object is a git_tag object
is_tree | Check if object is S3 class git_tree

## -- L --

last_commit | Last commit
length.git_blob | Size in bytes of the contents of a blob
length.git_diff | Number of files in git_diff object
length.git_tree | Number of entries in tree
libgit2_features | Compile time options for libgit2.
libgit2_version | Version of the libgit2 library
lookup | Lookup
lookup_commit | Lookup the commit related to a git object
lookup_commit.git_branch | Lookup the commit related to a git object
lookup_commit.git_commit | Lookup the commit related to a git object
lookup_commit.git_reference | Lookup the commit related to a git object
lookup_commit.git_tag | Lookup the commit related to a git object
ls_tree | List the contents of a tree object

## -- M --

merge.character | Merge a branch into HEAD
merge.git_branch | Merge a branch into HEAD
merge.git_repository | Merge a branch into HEAD
merge_base | Find a merge base between two commits

## -- N --

notes | List notes
note_create | Add note for a object
note_default_ref | Default notes reference
note_remove | Remove the note for an object

## -- O --

odb_blobs | Blobs in the object database
odb_objects | List all objects available in the database

## -- P --

parents | Parents
plot.git_repository | Plot commits over time
print.git_reflog_entry | Print a reflog entry
print.git_time | Time
pull | Pull
punch_card | Punch card
push | Push

## -- R --

references | Get all references that can be found in a repository.
reflog | List and view reflog information
remotes | Get the configured remotes for a repo
remote_add | Add a remote to a repo
remote_ls | List references in a remote repository
remote_remove | Remove a remote
remote_rename | Rename a remote
remote_set_url | Set the remote's url in the configuration
remote_url | Get the remote url for remotes in a repo
repository | Open a repository
repository_head | Get HEAD for a repository
reset | Reset current HEAD to the specified state
revparse_single | Revparse
rm_file | Remove files from the working tree and from the index

## -- S --

sha | Get the SHA-1 of a git object
sha.git_blob | Get the SHA-1 of a git object
sha.git_branch | Get the SHA-1 of a git object
sha.git_commit | Get the SHA-1 of a git object
sha.git_fetch_head | Get the SHA-1 of a git object
sha.git_merge_result | Get the SHA-1 of a git object
sha.git_note | Get the SHA-1 of a git object
sha.git_reference | Get the SHA-1 of a git object
sha.git_reflog_entry | Get the SHA-1 of a git object
sha.git_tag | Get the SHA-1 of a git object
sha.git_tree | Get the SHA-1 of a git object
ssh_path | Compose usual path to ssh keys
ssl_cert_locations | Set the SSL certificate-authority locations
stash | Stash
stash_apply | Apply stash
stash_drop | Drop stash
stash_list | List stashes in repository
stash_pop | Pop stash
status | Status
summary.git_repository | Summary of repository
summary.git_stash | Summary of a stash
summary.git_tree | Summary of tree

## -- T --

tag | Create tag targeting HEAD commit in repository
tags | Tags
tag_delete | Delete an existing tag reference
tree | Tree

## -- W --

when | When
workdir | Workdir of repository

## -- misc --

[.git_tree | Extract object from tree