Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudyr/ghit
Lightweight GitHub Package Installer
https://github.com/cloudyr/ghit
cran devtools git git2r github installer r r-package
Last synced: 8 days ago
JSON representation
Lightweight GitHub Package Installer
- Host: GitHub
- URL: https://github.com/cloudyr/ghit
- Owner: cloudyr
- License: other
- Archived: true
- Created: 2016-01-03T02:45:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-02T22:01:26.000Z (over 6 years ago)
- Last Synced: 2024-08-13T07:14:37.480Z (4 months ago)
- Topics: cran, devtools, git, git2r, github, installer, r, r-package
- Language: R
- Homepage: https://cloud.r-project.org/package=ghit
- Size: 111 KB
- Stars: 43
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - cloudyr/ghit - Lightweight GitHub Package Installer (R)
README
This package is now deprecated.
No further updates will be made here or sent to CRAN.
Please use [**remotes**](https://cran.r-project.org/package=remotes) instead.
---
# ghit: Lightweight GitHub Package Installer
**ghit** provides a lightweight alternative to `devtools::install_github()` that uses git2r and the native R package management functionality to install R packages hosted on GitHub. At present, `devtools::install_github()` provides the most convenient way to install development versions of R packages, but devtools has 16 direct package dependencies and is therefore a quite heavy duty package to load simply to install packages.
ghit is therefore a simpler alternative to perform the single task of installing GitHub packages without the rest of devtools. It achieves this by using git2r to pull GitHub packages (including those requiring authentication), and relying on native R tools for building packages, storing those packages in a local and disposable CRAN-like repository, and installing them (and their dependencies) with `install.packages()`. From v0.2.15, an `install_bitbucket()` installer is also provided.
## Package Functionality
Like `devtools::install_github()`, `ghit::install_github()` is a vectorized package installer that is extremely flexible:
```R
library("ghit")
tmp <- file.path(tempdir(), "tmplib")
dir.create(tmp)
on.exit(unlink(tmp))
# single package
install_github("hadley/devtools", lib = tmp)
# multiple packages
install_github(c("hadley/devtools", "cloudyr/travisci"), lib = tmp)
# package in subdirectory
install_github("pablobarbera/twitter_ideology/pkg/tweetscores", lib = tmp)
# package in misnamed repository
install_github("klutometis/roxygen", lib = tmp)
# package at a given commit
install_github("leeper/rio@a8d0fca27", lib = tmp)
# package from a pull request
install_github("cloudyr/ghit#13", lib = tmp)
# package from a branch
install_github("kbenoit/quanteda[dev]", lib = tmp)
```
Note that branch names, commits, and subdirectories can be placed in essentially any order as long as the proper notation is followed.
## Profiling ##
ghit is similarly efficient to `devtools::install_github()`, but is much less verbose by default:
```R
> system.time(ghit::install_github("cloudyr/ghit"))
user system elapsed
0.92 0.29 4.64
> system.time(devtools::install_github("cloudyr/ghit"))
Downloading GitHub repo cloudyr/ghit@master
Installing ghit
"C:/PROGRA~1/R/R-32~1.3/bin/x64/R" --no-site-file --no-environ --no-save --no-restore CMD INSTALL \
"C:/Users/Thomas/AppData/Local/Temp/RtmpGGraeG/devtools1b6459fa28a1/cloudyr-ghit-45ac056" --library="C:/Program Files/R/R-3.2.3/library" \
--install-tests
* installing *source* package 'ghit' ...
** R
** inst
** tests
** preparing package for lazy loading
** help
*** installing help indices
** building package indices
** testing if installed package can be loaded
*** arch - i386
*** arch - x64
* DONE (ghit)
user system elapsed
1.16 0.12 4.36
```
## Package Installation
[](https://cran.r-project.org/package=ghit)
[](https://travis-ci.org/cloudyr/ghit)
[](https://ci.appveyor.com/project/cloudyr/ghit)
[](https://codecov.io/github/cloudyr/ghit?branch=master)
The package is available on [CRAN](https://cran.r-project.org/package=ghit) and can be installed directly in R using:
```R
install.packages("ghit")
```
The latest development version on GitHub can be installed using itself:
```R
ghit::install_github("cloudyr/ghit")
```