archive: Manage package archives.

Description Usage Arguments Value

Description

archive_platform() provide a platform description for the session in which this package is running.

archive_statistics() queries the archive for information about disk usage, available platforms, and archived packages.

archive_need() identifies which packages have been archived.

archive_install() builds, installs, and archives packages in tbl that are not already archived.

archive_update() updates all archived packages to their current version.

archive_add() allows packages to be archived without installation, e.g., when the archiver is not running on the target platform.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
archive_platform()

archive_statistics(platform = archive_platform(), bioc_version = version())

archive_need(tbl, platform = archive_platform(), bioc_version = version())

archive_install(
  tbl,
  platform = archive_platform(),
  bioc_version = version(),
  repos = repositories(),
  verbose = getOption("verbose")
)

archive_update(
  platform = archive_platform(),
  bioc_version = version(),
  repos = repositories(),
  verbose = getOption("verbose")
)

archive_add(
  source,
  platform = archive_platform(),
  bioc_version = version(),
  force = FALSE
)

Arguments

platform

character(1) description of the platform for which packages are being archived. The default is the platform on which the function is being evaluated.

bioc_version

Bioconductor version for which the archive applies. Default is from BiocManager::version().

tbl

a tibble() with character columns Package and Version.

repos

character() of CRAN-style repositories where packages sources are to be retrieved from.

verbose

logical(1) request for additional progress indications, including from install.packages().

source

character() path to local file system built tarballs of packages to be archived, or directories of built packages (e.g., the installation library path of the building platform).

force

logical(1) force update of identical archives.

Value

archive_platform() returns character(1) description of the platform.

archive_statistics() returns an S3 list-based object with package statistics, visuallized using print().

archive_need() returns a tibble with of Package, Version, and digest of all packages needing to be archived.

archive_install() returns a tbl containing Package, Version, digest, and archive path suitable for use in binary installation via install.packages().

archive_update() returns a tibble of newly archived packages with the same structure as archive_install().

archive_add() returns a tibble with Package, Version, digest, and is_archived flag indicating success at archiving the package.


mtmorgan/pkgserver documentation built on Feb. 25, 2020, 3:54 a.m.