Package 'githubinstall'

Install Packages from GitHub

Description

Install Packages from GitHub

Usage

gh_install_packages(packages, ask = TRUE, ref = "master",
  build_vignettes = FALSE, dependencies = NA, verbose = TRUE,
  quiet = !verbose, lib = NULL, ...)

githubinstall(packages, ask = TRUE, ref = "master",
  build_vignettes = FALSE, dependencies = NA, verbose = TRUE,
  quiet = !verbose, lib = NULL, ...)

Arguments

packages	character vector of the names of the packages. You can specify ref argument (see below) using package_name[@ref|#pull]. If both are specified, the values in repo take precedence.
ask	logical. Indicates ask to confirm before install.
ref	character vector. Desired git reference. Could be a commit, tag, or branch name, or a call to github_pull. Defaults to "master".
build_vignettes	logical. If TRUE, will build vignettes.
dependencies	logical. Indicating to also install uninstalled packages which the packages depends on/links to/suggests. See argument dependencies of install.packages.
verbose	logical. Indicating to print details of package building and installation. Dfault is TRUE.
quiet	logical. Not verbose.
lib	character vector giving the library directories where to install the packages. Recycled as needed. Defaults to the first element of .libPaths().
...	additional arguments to control installation of package, passed to install_github.

Details

githubinstall() is an alias of gh_install_packages().

Value

TRUE if success.

Examples

## Not run: 
gh_install_packages("AnomalyDetection")
githubinstall("AnomalyDetection")

## End(Not run)

---

Get Information of Packages on GitHub

Description

Get Information of Packages on GitHub

Usage

gh_list_packages(username = NULL)

Arguments

username

a character vector as GitHub username. If you set NULL (default), it returns all packages information.

Value

a data.frame that has author, package name and title.

Examples

## Not run: 
gh_list_packages("hadley")

## End(Not run)

---

Search Packages from Titles by Regular Expressions

Description

Search Packages from Titles by Regular Expressions

Usage

gh_search_packages(regex, ignore.case = TRUE)

Arguments

regex	a character string containing a regular expression to be matched in the package titles.
ignore.case	logical. If FALSE, the pattern matching is case sensitive and if TRUE, case is ignored during matching.

Value

a data.frame of package information.

Examples

## Not run: 
gh_search_packages("lasso")

## End(Not run)

---

Find source code for functions in packages on GitHub

Description

Find source code for functions in packages on GitHub

Usage

gh_show_source(func, repo = NULL, browser = getOption("browser"))

Arguments

func	a function or a character string. A function name.
repo	a character string. A GitHub repository name that must not be exactry.
browser	a character string giving the name of the program to be used as the HTML browser.

Examples

## Not run: 
gh_show_source("mutate", "dplyr")

library(dplyr)
gh_show_source(mutate)

## End(Not run)

---

Suggest Github Repository from a Incomplete Name

Description

Suggest Github Repository from a Incomplete Name

Usage

gh_suggest(repo_name, keep_title = FALSE)

Arguments

repo_name	a character. A part of a repository name.
keep_title	logical. Indicates to keep the package titles as an attrbite. Default FALSE.

Value

candidates for the repository name.

Examples

gh_suggest("AnomalyDetection")
# [1] "twitter/AnomalyDetection"
gh_suggest("BnomalyDetection")
# [1] "twitter/AnomalyDetection"
gh_suggest("uwitter/BnomalyDetection")
# [1] "twitter/AnomalyDetection"

---

Suggest Github Username from a Faint Memory

Description

Suggest Github Username from a Faint Memory

Usage

gh_suggest_username(vague_name)

Arguments

vague_name

a character. GitHub username that may not be exact.

Details

The trouble is that the usernames of GitHub are often hard to remember. The function provides a way to obtain usernames from a faint memory.

Value

a character vector of the closest usernames to input.

Examples

## Not run: 
gh_guess_username("yuhui")
# [1] "yihui"

## End(Not run)

---

Update the List of Packages on GitHub.

Description

Update the List of Packages on GitHub.

Usage

gh_update_package_list()

---

The default "dependencies" is NA that means c("Depends", "Imports", "LinkingTo"). If "build_vignettes" is TRUE, the install needs "Suggests" dependency in many cases. So we recommend in such case to set "dependencies" to TRUE that means c("Depends", "Imports", "LinkingTo", "Suggests").

Description

The default "dependencies" is NA that means c("Depends", "Imports", "LinkingTo"). If "build_vignettes" is TRUE, the install needs "Suggests" dependency in many cases. So we recommend in such case to set "dependencies" to TRUE that means c("Depends", "Imports", "LinkingTo", "Suggests").

Usage

recommend_dependencies(ask, build_vignettes, dependencies, quiet)

Arguments

ask	logical. Indicates ask to confirm before install.
build_vignettes	logical. If TRUE, will build vignettes.
dependencies	logical. Indicating to also install uninstalled packages which the packages depends on/links to/suggests. See argument dependencies of install.packages.
quiet	logical. Not verbose.

---

We want to detect the two conflict cases as fllows: 1. The package is already installed from some repository like CRAN that is not GitHub. 2. The package is already installed from GtiHub but the username differs. In the above cases, we ask whether to overwrite it and remove from "repo" if the answer is no.

Description

If "quiet" is TRUE, we overwrite all packages forcibly and silently. Else if "quiet" is FALSE and "ask" is TRUE, we ask whether to overwrite it. (Default) Else if "quiet" is FALSE and "ask" is FALSE, we message to overwrite it and do it.

Usage

remove_conflict_repos(repos, lib, quiet, ask)

Arguments

repos	charactor vector of full GitHub repository names.
lib	character vector or NULL.
quiet	logical.
ask	logical.

---

Suggest candidates from "package_name" and make user selected one of them.

Description

Suggest candidates from "package_name" and make user selected one of them.

Usage

select_repository(package_name)

Arguments

package_name

a character string. A package name or full GitHub repository name.

Value

candidate with title

---

The "repo" argument allows to contain "ref" as "package_name@ref", "package_name#pull" or "package_name[branch]". The function detects that "repo" contains "ref" and separates into pure repo and ref. If "repo" contains "ref" and "ref" argument is specified, the values in "repo" take precedence.

Description

The "repo" argument allows to contain "ref" as "package_name@ref", "package_name#pull" or "package_name[branch]". The function detects that "repo" contains "ref" and separates into pure repo and ref. If "repo" contains "ref" and "ref" argument is specified, the values in "repo" take precedence.

Usage

separate_into_package_and_reference(packages, original_ref)

Arguments

packages	"repo" argument.
original_ref	"ref" argument.

---