R/update.R

Defines functions update_cran

Documented in update_cran

#' Update local CRAN with the package
#'
#' Import package files into a local CRAN and update the metadata. Check the README in the repo.
#'
#' @param package_file The location of the package file in either `tar.gz` format (source/Linux),
#' `zip` (Windows) or `tgz` (Mac).
#' @param cran_root The folder containing the CRAN.
#' @param distro Only relevant for **binary** Linux packages. The name of the Linux distribution
#' compiling the package. The only restriction is that it should fit in a URL. As an example,
#' `ubuntu/focal` is a permitted name.
#'
#' @export
update_cran <- function(package_file, cran_root, distro = "ubuntu/focal") {
    switch(
        package_ext(package_file),
        "tar.gz" = update_cran_tar(package_file, cran_root, distro),
        "zip"    = update_cran_win(package_file, cran_root)
        # "tgz"    = update_cran_mac(package_file, cran_root)
    )
}
robertdj/cranitor documentation built on March 25, 2021, 6:22 a.m.