https://github.com/fastgitorg/fgitr
Using FastGit to accelerate the access to GitHub
https://github.com/fastgitorg/fgitr
r r-package
Last synced: 3 months ago
JSON representation
Using FastGit to accelerate the access to GitHub
- Host: GitHub
- URL: https://github.com/fastgitorg/fgitr
- Owner: FastGitORG
- License: other
- Created: 2021-10-05T17:09:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-01T05:02:23.000Z (over 4 years ago)
- Last Synced: 2025-09-08T15:47:20.292Z (9 months ago)
- Topics: r, r-package
- Language: R
- Homepage: https://fastgitorg.github.io/fgitR/
- Size: 461 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# fgitR
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://app.codecov.io/gh/FastGitORG/fgitR?branch=main)
[`FastGit`](https://doc.fastgit.org/) works as a mirror of `GitHub` to make significant accelerations.
`fgitR` is a package to do git operation with `FastGit` automatically.
## Installation
`figtR` has been released in [CRAN](https://CRAN.R-project.org/package=fgitR). You can install the released version of fgitR from [CRAN](https://CRAN.R-project.org) with:
``` r
# Install from CRAN
install.packages("fgitR")
# Compiling from Source
remotes::install_github("FastGitORG/fgitR")
# For upgrade installed `fgitR`
fgitR::fgit_install("FastGitORG/fgitR")
```
## Install package from Source
```{r install_package_from_source, cache=TRUE}
library(fgitR)
# fgitR can install package by Repository's Name
# fgitR_install("https://github.com/r-lib/diffviewer")
# fgitR can install package by Repository's URL
fgit_install("r-lib/diffviewer")
```
## List all branch from Remote
```{r list_branch, cache=TRUE}
branch_ls <-
fgit_branch("FastGitORG/fgitR")
branch_ls
```
### Reinventing the wheel?
For the initially consideration, we believe it is necessary to add following functions:
- Commit
- Pull
- Push
Due to `git` is not only clone to local, but also contribute back. But in the `git clone` or `fgit clone` procedure, the remote will be set as `fastgit.org` or other mirror domain. Hence, there is nothing special to make further operations.
## Bug report
Feel free to [let me know](mailto://chenhan28@gmail.com) once it's broken or just open an Issue.
## Code of Conduct
Please note that the fgitR project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.