1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/repository.R
\name{repository}
\alias{repository}
\title{Open a repository}
\usage{
repository(path = ".", discover = TRUE)
}
\arguments{
\item{path}{A path to an existing local git repository.}
\item{discover}{Discover repository from path. Default is TRUE.}
}
\value{
A \code{git_repository} object with entries:
\describe{
\item{path}{
Path to a git repository
}
}
}
\description{
Open a repository
}
\examples{
\dontrun{
## Initialize a temporary repository
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)
# Configure a user
config(repo, user.name = "Alice", user.email = "alice@example.org")
## Create a file, add and commit
writeLines("Hello world!", file.path(path, "test-1.txt"))
add(repo, 'test-1.txt')
commit_1 <- commit(repo, "Commit message")
## Make one more commit
writeLines(c("Hello world!", "HELLO WORLD!"),
file.path(path, "test-1.txt"))
add(repo, 'test-1.txt')
commit(repo, "Next commit message")
## Create one more file
writeLines("Hello world!",
file.path(path, "test-2.txt"))
## Brief summary of repository
repo
## Summary of repository
summary(repo)
## Workdir of repository
workdir(repo)
## Check if repository is bare
is_bare(repo)
## Check if repository is empty
is_empty(repo)
## Check if repository is a shallow clone
is_shallow(repo)
## List all references in repository
references(repo)
## List all branches in repository
branches(repo)
## Get HEAD of repository
repository_head(repo)
## Check if HEAD is head
is_head(repository_head(repo))
## Check if HEAD is local
is_local(repository_head(repo))
## List all tags in repository
tags(repo)
}
}
|
