Update an existing repository by reading the
file, retaining entries which are still valid, removing entries which
are no longer valid, and only processing built package tarballs which do not
match existing entries.
update_PACKAGES can be much faster than
write_PACKAGES for small-moderate changes to large
repository indexes, particularly in non-strict mode (see Details).
update_PACKAGES(dir = ".", fields = NULL, type = c("source", "mac.binary", "win.binary"), verbose.level = as.integer(dryrun), latestOnly = TRUE, addFiles = FALSE, rds_compress = "xz", strict = TRUE, dryrun = FALSE)
(0, 1, 2) What level of informative messages
which should be displayed throughout the process. Defaults to 0 if
logical. Should 'strict mode' be used when checking
logical. Should the updates to existing
Throughout this section, package tarball is defined to mean any
archive file in
dir whose name can be interpreted as
<package>_<version>.<ext> - with
<ext> the appropriate
extension for built packages of type
type - (or that is pointed
to by the
File field of an existing
Novel package tarballs are those which do not match an existing
PACKAGES file entry.
update_PACKAGES calls directly down to
write_PACKAGES with a warning (and thus all package tarballs
will be processed), if any of the following conditions hold:
TRUE (no MD5 checksums are included in win.binary
PACKAGES file exists under
PACKAGES file exists under
dir but is empty
fields is not
NULL and one or more specified fields
are not present in the existing
update_PACKAGES avoids (re)processing package tarballs in cases where
PACKAGES file entry already exists and appears to remain valid. The
logic for detecting still-valid entries is as follows:
Any package tarball which was last modified more recently than the
PACKAGES file is considered novel; existing
PACKAGES entries appearing to correspond to such tarballs are
always considered stale and replaced by newly generated ones.
PACKAGES entries that do not correspond to any
package tarball found in
dir are considered invalid and are
excluded from the resulting updated
PACKAGES entries that match a package
tarball (by package name and version) are confirmed via MD5 checksum;
only those that pass are retained as valid. All novel package tarballs
are fully processed by the standard machinery underlying
write_PACKAGES and the resulting entries are
added. Finally, if
pruning is performed across the entries.
FALSE, package tarballs are assumed to encode
correct metadata in their filenames.
PACKAGES entries which
appear to match a package tarball are retained as valid (No MD5 checksum
testing occurs). If
pruning is performed across the full set of retained entries and novel package
tarballs before the processing of the novel tarballs, at
significant computational and time savings in some
situations. After the optional pruning, any relevant novel package
tarballs are processed via the standard machinery and added to the
set of retained entries.
In both cases, after the above process concludes, entries are sorted
alphabetically by the string concatenation of
Version. This should match the entry order
The fields within the entries are ordered as follows: canonical fields -
i.e., those appearing as columns when
called on a CRAN mirror - appear first in their canonical order,
followed by any non-canonical fields.
After entry and field reordering, the final database of
entries is written to all three
PACKAGES files, overwriting the
0, no extra messages are displayed
to the user. When it is
1, detailed information about what is
happening is conveyed via messages, but underlying machinery from
write_PACKAGES is invoked with
verbose = FALSE.
2 is identical to
1 with the exception that underlying
write_PACKAGE is invoked with
verbose = TRUE, which will individually list every processed
While both strict and non-strict modes can offer speedups when updating small percentages of large repositories, non-strict mode is much faster and is recommended in situations where the assumption it makes about tarballs' filenames encoding accurate information is safe.
Users should expect significantly smaller speedups over
write_PACKAGES in the
type == "win.binary" case on at
least some operating systems. This is due to
significantly faster in this context, rather than
Gabriel Becker (adapted from previous, related work by him in the
package which is copyright Genentech, Inc.)
## Not run: write_PACKAGES("c:/myFolder/myRepository") # on Windows update_PACKAGES("c:/myFolder/myRepository") # on Windows write_PACKAGES("/pub/RWin/bin/windows/contrib/2.9", type = "win.binary") # on Linux update_PACKAGES("/pub/RWin/bin/windows/contrib/2.9", type = "win.binary") # on Linux ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.