-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.Rmd
58 lines (38 loc) · 2.67 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
[](https://cran.r-project.org/package=ghentr)
[](https://travis-ci.org/ijlyttle/ghentr)
# ghentr
The goal of ghentr is to make it easier for you to build and share a private package-ecosystem using your instance of GitHub Enterprise.
You are likely already using the functions `devtools::install_github()` and `usethis::use_github()` to interact with `github.com`. If you have an instance GitHub Enterprise (GHE), you can also use these functions with GHE.
Let's say that you work for [Acme Corporation](https://en.wikipedia.org/wiki/Acme_Corporation), and that Acme has its own instance of GHE. At present, you could install a package using the `host` argument with `devtools::install_github`.
```{r eval=FALSE}
devtools::install_github("user/repo", host = "github.acme-corp.com/api/v3")
```
In time, it may become tiresome to add the host argument each time you want to install a package from GHE. Instead, it might be handy to create a function to do this for you, then put that function into a package that you can use and make available to your colleagues. This is what **ghentr** helps you to do.
Assuming you create a package called **acmetools**, you can use templating functions in **ghentr** to add a function to **acmetools** that would allow you to use syntax like this:
```{r eval=FALSE}
# wraps devtools::install_github()
acmetools::install_github_acme("user/repo")
```
There are two ways **ghentr** can help you work with GitHub Enterprise:
- To make functions that wrap `devtools::install_github()` and `usethis::use_github()`, described in an [article](https://ijlyttle.github.io/ghentr/articles/using_ghe.html).
- To initalize and manage a private CRAN-like repository using [drat](https://CRAN.R-project.org/package=drat), described in another [article](https://ijlyttle.github.io/ghentr/articles/using_repository.html).
Here are the slides ([PDF](https://github.com/ijlyttle/ghentr/blob/master/presentation/rstudioconf-2018.pdf)) from a presentation given at rstudio::conf(2018).
## Installation
You can install ghentr from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("ijlyttle/ghentr")
```
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.