| Type: | Package |
| Title: | Using 'FastGit' to Accelerate the Access to 'GitHub' |
| Version: | 0.2.0 |
| Description: | 'FastGit' https://doc.fastgit.org/ works like a mirror of 'GitHub' to make significant acceleration. 'fgitR' is a package to do git operation with 'FastGit' automatically. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| Depends: | R (≥ 3.6.0) |
| Suggests: | covr, testthat (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| RoxygenNote: | 7.1.2 |
| Imports: | httr, devtools, git2r |
| SystemRequirements: | Git |
| BugReports: | https://github.com/FastGitORG/fgitR/issues |
| NeedsCompilation: | no |
| Packaged: | 2022-02-25 07:49:50 UTC; chenhan |
| Author: | Han Chen [aut, cre], Wanyanhan Jiang [ctb] |
| Maintainer: | Han Chen <chenhan28@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2022-02-28 20:10:02 UTC |
List all branch from a repository
Description
List all branch from a repository
Usage
fgit_branch(repo)
Arguments
repo |
The repository's name from GitHub.com |
Value
A vector of branches
Examples
## Not run:
fgit_branch("https://github.com/FastGitORG/fgitR")
fgit_branch("FastGitORG/fgitR")
## End(Not run)
Git Clone from URL by FastGit
Description
Git Clone from URL by FastGit
Usage
fgit_clone(
repo,
dir = tempdir(),
branch = NULL,
repo_check = TRUE,
overwrite = FALSE,
verbose = TRUE
)
Arguments
repo |
The repository name or url from GitHub.com |
dir |
The output directory. 'tempdir()' will be used by default. |
branch |
Clone from which branch. |
repo_check |
Check the existence of repository |
overwrite |
Overwrite the exist directories. Default is 'FALSE' |
verbose |
Verbose logs. Default is 'TRUE' |
Value
No return value, called for side effects
Examples
## Not run:
fgit_clone("https://github.com/womeimingzi11/fgitR", overwrite = TRUE)
fgit_clone("womeimingzi11/fgitR", overwrite = TRUE)
## End(Not run)
Git Clone by FastGit's URL
Description
Git Clone by FastGit's URL
Usage
fgit_clone_from_url(fgit_url, target_dir, branch = NULL, verbose = TRUE)
Arguments
fgit_url |
The repository's name from FastGit.org |
target_dir |
The output directory |
branch |
Clone from which branch. |
verbose |
Verbose logs. Default is 'TRUE' |
Install package from GitHub by FastGit accelerating
Description
Install package from GitHub by FastGit accelerating
Usage
fgit_install(repo, branch = NULL, repo_check = TRUE)
Arguments
repo |
The repository name or url from GitHub.com |
branch |
Install from which branch. |
repo_check |
Check the existence of repository |
Value
No return value, called for side effects
Examples
## Not run:
fgit_install("https://github.com/FastGitORG/fgitR")
fgit_install("FastGitORG/fgitR")
## End(Not run)
A function to make directory
Description
A function to make directory
Usage
func_mk_dir(target_dir, overwrite = FALSE, verbose = TRUE)
Arguments
target_dir |
Path of target Directory |
overwrite |
Overwrite the exist directories. Default is 'FALSE' |
verbose |
Verbose logs. Default is 'TRUE' |
Extract the Repository Name from URL or Name
Description
Extract the Repository Name from URL or Name
Usage
git_repo_extract(url_or_repo, repo_check = TRUE)
Arguments
url_or_repo |
URL or Name from GitHub.com |
repo_check |
Repo Existence Check |
Value
Character like user/repository