1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/install-github.R
3\name{github_remote}
4\alias{github_remote}
5\title{Create a new github_remote}
6\usage{
7github_remote(
8  repo,
9  ref = "HEAD",
10  subdir = NULL,
11  auth_token = github_pat(),
12  sha = NULL,
13  host = "api.github.com",
14  ...
15)
16}
17\arguments{
18\item{repo}{Repository address in the format
19\verb{username/repo[/subdir][@ref|#pull|@*release]}. Alternatively, you can
20specify \code{subdir} and/or \code{ref} using the respective parameters
21(see below); if both are specified, the values in \code{repo} take
22precedence.}
23
24\item{ref}{Desired git reference. Could be a commit, tag, or branch
25name, or a call to \code{\link[=github_pull]{github_pull()}} or \code{\link[=github_release]{github_release()}}. Defaults to
26\code{"HEAD"}, which means the default branch on GitHub and for git remotes.
27See \href{https://help.github.com/en/github/administering-a-repository/setting-the-default-branch}{setting-the-default-branch}
28for more details.}
29
30\item{subdir}{Subdirectory within repo that contains the R package.}
31
32\item{auth_token}{To install from a private repo, generate a personal
33access token (PAT) with at least repo scope in
34\url{https://github.com/settings/tokens} and
35supply to this argument. This is safer than using a password because
36you can easily delete a PAT without affecting any others. Defaults to
37the \code{GITHUB_PAT} environment variable.}
38
39\item{host}{GitHub API host to use. Override with your GitHub enterprise
40hostname, for example, \code{"github.hostname.com/api/v3"}.}
41
42\item{...}{Other arguments passed on to \code{\link[utils:install.packages]{utils::install.packages()}}.}
43}
44\description{
45This is an internal function to create a new github_remote, users should
46generally have no need for it.
47}
48\keyword{internal}
49