# Provides Access to Git Repositories

## Documentation for package ‘git2r’ version 0.18.0

- DESCRIPTION file.
- Package NEWS.

## Help Pages

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

git2r-package | git2r: R bindings to the libgit2 library

## -- A --

add | Add file(s) to index
add-method | Add file(s) to index
ahead_behind | Ahead Behind
ahead_behind-method | Ahead Behind

## -- B --

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

## -- C --

checkout | Checkout
checkout-method | Checkout
clone | Clone a remote repository
clone-method | Clone a remote repository
coerce-git_commit-method | Coerce a commit to a 'data.frame'
coerce-git_repository-method | Coerce Git repository to a 'data.frame'
coerce-git_tree-data.frame-method | Coerce entries in a git_tree to a 'data.frame'
coerce-git_tree-list-method | Coerce entries in a git_tree to a list of entry objects
coerce-method | Coerce a commit to a 'data.frame'
coerce-method | Coerce Git repository to a 'data.frame'
coerce-method | Coerce entries in a git_tree to a 'data.frame'
coerce-method | S4 class to handle a git time in a signature
commit | Commit
commit-method | Commit
commits | Commits
commits-method | Commits
config | Config
content | Content of blob
content-method | Content of blob
contributions | Contributions
contributions-method | Contributions
cred_env | Create a new environmental credential object
cred_env-class | S4 class to handle environmental variables credential object
cred_env-method | Create a new environmental credential object
cred_ssh_key | Create a new passphrase-protected ssh key credential object
cred_ssh_key-class | S4 class to handle a passphrase-protected ssh key credential object
cred_token | Create a new personal access token credential object
cred_token-class | S4 class to handle a personal access token credential object
cred_user_pass | Create a new plain-text username and password credential object
cred_user_pass-class | S4 class to handle plain-text username and password credential object
cred_user_pass-method | Create a new plain-text username and password credential object

## -- D --

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

## -- F --

fetch | Fetch new data and update tips
fetch-method | Fetch new data and update tips
fetch_heads | Get updated heads during the last fetch.
fetch_heads-method | Get updated heads during the last fetch.

## -- G --

git2r | git2r: R bindings to the libgit2 library
git_blame-class | S4 class to handle a git blame for a single file
git_blame_hunk-class | S4 class to represent a blame hunk
git_blob-class | S4 class to handle a git blob
git_branch-class | S4 class to handle a git branch
git_commit-class | S4 class to handle a git commit.
git_diff-class | Git diff
git_diff_file-class | Git diff file
git_diff_hunk-class | Git diff hunk
git_diff_line-class | Git diff line
git_fetch_head-class | S4 class to handle a fetch head
git_merge_result-class | S4 class to handle the merge result
git_note-class | S4 class to handle a git note
git_reference-class | S4 class to handle a git reference
git_reflog_entry-class | S4 class to handle a git reflog entry.
git_repository-class | S4 class to handle a git repository
git_signature-class | S4 class to handle a git signature
git_stash-class | S4 class to handle a git stash
git_tag-class | S4 class to handle a git tag
git_time-class | S4 class to handle a git time in a signature
git_transfer_progress-class | Class '"git_transfer_progress"'
git_tree-class | S4 class to handle a git tree

## -- H --

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

## -- I --

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

## -- L --

length-method | Size in bytes of the contents of a blob
length-method | Number of files in git_diff object
length-method | Number of entries in tree
libgit2_features | Compile time options for libgit2.
libgit2_sha | SHA of the libgit2 library
libgit2_version | Version of the libgit2 library
lookup | Lookup
lookup-method | Lookup

## -- M --

merge-method | Merge a branch into HEAD
merge_base | Find a merge base between two commits
merge_base-method | Find a merge base between two commits

## -- N --

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

## -- O --

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

## -- P --

parents | Parents
parents-method | Parents
plot | Plot commits over time
plot-method | Plot commits over time
pull | Pull
pull-method | Pull
punch_card | Punch card
punch_card-method | Punch card
push | Push
push-method | Push

## -- R --

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

## -- S --

show,git_blob-methods | Brief summary of blob
show,git_branch-methods | Brief summary of branch
show,git_commit-methods | Brief summary of commit
show,git_diff-methods | Show a diff
show,git_merge_result-methods | Brief summary of merge result
show,git_note-methods | Brief summary of note
show,git_reference-methods | Brief summary of reference
show,git_reflog_entry-methods | Brief summary of a reflog entry
show,git_repository-methods | Brief summary of repository
show,git_signature-methods | Brief summary of signature
show,git_stash-methods | Brief summary of a stash
show,git_tag-methods | Brief summary of a tag
show,git_time-methods | Brief summary of 'git_time'
show,git_tree-methods | Brief summary of tree
show-method | Brief summary of blob
show-method | Brief summary of branch
show-method | Brief summary of commit
show-method | Show a diff
show-method | Brief summary of merge result
show-method | Brief summary of note
show-method | Brief summary of reference
show-method | Brief summary of a reflog entry
show-method | Brief summary of repository
show-method | Brief summary of signature
show-method | Brief summary of a stash
show-method | Brief summary of a tag
show-method | Brief summary of 'git_time'
show-method | Brief summary of tree
ssl_cert_locations | Set the SSL certificate-authority locations
stash | Stash
stash-method | Stash
stash_drop | Drop stash
stash_drop-method | Drop stash
stash_list | List stashes in repository
stash_list-method | List stashes in repository
status | Status
status-method | Status
summary,git_commit-methods | Summary of commit
summary,git_diff-methods | Show the summary of a diff
summary,git_repository-methods | Summary of repository
summary,git_stash-methods | Summary of a stash
summary,git_tag-methods | Summary of a tag
summary,git_tree-methods | Summary of tree
summary-method | Summary of blob
summary-method | Summary of commit
summary-method | Show the summary of a diff
summary-method | Summary of repository
summary-method | Summary of a stash
summary-method | Summary of a tag
summary-method | Summary of tree

## -- T --

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

## -- W --

when | When
when-method | When
workdir | Workdir of repository
workdir-method | Workdir of repository

## -- misc --

[-method | Extract object from tree