get_remote_package_dcf: Read Remote Package DESCRIPTION file

Description Usage Arguments Value Examples

View source: R/remote_package_dcf.R

Description

Read Remote Package DESCRIPTION file

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
get_remote_package_dcf(
  remotes,
  pat = NULL,
  url = c("https://github.com", "https://api.github.com"),
  output_directory = NULL,
  overwrite = FALSE,
  ...
)

remote_package_dcf(...)

has_remote_dcf(remotes, pat = NULL, url = "https://github.com", ...)

Arguments

remotes

Repository name

pat

GitHub Personal Authentication Token (PAT)

url

URL for repo - github

output_directory

Output directory for the description file to download to,

overwrite

overwrite the file if exists. Only really relevant if output_directory is not NULL

...

additional arguments to pass to GET

Value

List of Package/Version DCF information

Examples

1
2
3
4
5
get_remote_package_dcf("stnava/ANTsRCore")
out = get_remote_package_dcf("stnava/ANTsRCore", output_directory = tempdir())
out = get_remote_package_dcf("stnava/ANTsRCore", output_directory = tempdir())
remote_package_dcf("stnava/ANTsRCore")
remote_package_dcf("stnava/ANTsRCore", output_directory = tempdir())

muschellij2/ghtravis documentation built on April 1, 2021, 5:22 p.m.