pkgzip_build_github_package: Builds PKGZIP out of a package on GitHub.

In RSuite: Supports Developing, Building and Deploying R Solution

Description

Loads package from the GitHub repository, packages it into package file and builds a PKGZIP out of it. It uses the project to detect repositories to look for dependencies and to detect rversion if required.

Usage

pkgzip_build_github_package(repo, ..., prj = NULL,
  pkg_type = .Platform$pkgType, path = getwd(), with_deps = FALSE,
  filter_repo = NULL, skip_build_steps = NULL, keep_sources = FALSE)

Arguments

repo	repository address in format username/repo[/subdir][\@ref|#pull]. See devtools::install_github for more information.
...	GitHub specific parameters passed to devtools::install_github.
prj	project object to use. If not passed will init project from working directory. (type: rsuite_project, default: NULL)
pkg_type	type of packages to build (type: character, default: platform default)
path	folder path to put output zip into. The folder must exist. (type: character: default: getwd())
with_deps	If TRUE will include dependencies pkgs dependencies into final zip. (type: logical, default: FALSE)
filter_repo	repository address to not include dependencies available in. If NULL will not filter dependencies. Will be omitted if with_deps is FALSE. (type: character(1), default: NULL)
skip_build_steps	character vector with steps to skip while building project packages. Can contain following entries: specs Process packages specifics docs Try build documentation with roxygen imps Perform imports validation tests Run package tests rcpp_attribs Run rppAttribs on the package vignettes Build package vignettes (type: character(N), default: NULL).
keep_sources	if TRUE downloaded package sources will not be removed after building. (type: logical, default: FALSE)

Details

Logs all messages onto rsuite logger. Use logging::setLevel to control logs verbosity.

Value

created pkgzip file path (invisible).

See Also

Other in PKGZIP building: pkgzip_build_bioc_package, pkgzip_build_ext_packages, pkgzip_build_package_files, pkgzip_build_prj_packages

Examples

  # create exemplary project base folder
  prj_base <- tempfile("example_")
  dir.create(prj_base, recursive = TRUE, showWarnings = FALSE)

  # start project
  prj <- prj_start("my_project", skip_rc = TRUE, path = prj_base)

  # build PKGZIP with logging package from cran repository
  pkgzip_fpath <- pkgzip_build_github_package("cran/logging", prj = prj, path = tempdir())

  # list content of pkgzip created
  unzip(pkgzip_fpath, list = TRUE)

RSuite documentation built on June 10, 2019, 5:03 p.m.