The R Project SVN R

Rev

Rev 76358 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 76358 Rev 85102
Line 6... Line 6...
6 
  "mac.binary", "win.binary"), verbose.level = as.integer(dryrun),
 6 
  "mac.binary", "win.binary"), verbose.level = as.integer(dryrun),
7 
  latestOnly = TRUE, addFiles = FALSE, rds_compress = "xz",
 7 
  latestOnly = TRUE, addFiles = FALSE, rds_compress = "xz",
8 
  strict = TRUE, dryrun = FALSE)
 8 
  strict = TRUE, dryrun = FALSE)
9 
}
 9 
}
10 
\arguments{
 10 
\arguments{
11 
\item{dir}{See \code{\link{write_PACKAGES}}}
 11 
\item{dir}{see \code{\link{write_PACKAGES}}.}
12 
 
 12 
 
13 
\item{fields}{See \code{\link{write_PACKAGES}}}
 13 
\item{fields}{see \code{\link{write_PACKAGES}}.}
14 
 
 14 
 
15 
\item{type}{See \code{\link{write_PACKAGES}}}
 15 
\item{type}{see \code{\link{write_PACKAGES}}.}
16 
 
 16 
 
17 
\item{verbose.level}{(0, 1,  2) What level of informative messages
 17 
\item{verbose.level}{one of \{0, 1, 2\}, the level of informative messages
18 
which should be displayed throughout the process. Defaults to 0 if
 18 
displayed throughout the process. Defaults to 0 if
19 
\code{dryrun}   is   \code{FALSE}    (the   default)   and   1
 19 
\code{dryrun} is \code{FALSE} (the default) and 1
20 
otherwise. See details for more information.}
 20 
otherwise. See Details for more information.}
21 
 
 21 
 
22 
\item{latestOnly}{See \code{\link{write_PACKAGES}}}
 22 
\item{latestOnly}{see \code{\link{write_PACKAGES}}.}
23 
 
 23 
 
24 
\item{addFiles}{See \code{\link{write_PACKAGES}}}
 24 
\item{addFiles}{see \code{\link{write_PACKAGES}}.}
25 
 
 25 
 
26 
\item{rds_compress}{See \code{\link{write_PACKAGES}}}
 26 
\item{rds_compress}{see \code{\link{write_PACKAGES}}.}
27 
 
 27 
 
28 
\item{strict}{logical. Should 'strict mode' be used when checking
 28 
\item{strict}{logical. Should \dQuote{strict mode} be used when checking
29 
existing \code{PACKAGES} entries. See details. Defaults to
 29 
existing \code{PACKAGES} entries. See Details. Defaults to
30 
\code{TRUE}.}
 30 
\code{TRUE}.}
31 
 
 31 
 
32 
\item{dryrun}{logical. Should the updates to existing \code{PACKAGES}
 32 
\item{dryrun}{logical. Should the updates to existing \code{PACKAGES}
33 
  files be computed but NOT applied. Defaults to \code{FALSE}.}
 33 
  files be computed but NOT applied. Defaults to \code{FALSE}.}
34 
 
 - 
 
35 
}
 34 
}
36 
\description{
 35 
\description{
37 
Update an existing repository by reading the \code{PACKAGES}
 36 
Update an existing repository by reading the \code{PACKAGES}
38 
file, retaining entries which are still valid, removing entries which
 37 
file, retaining entries which are still valid, removing entries which
39 
are no longer valid, and only processing built package tarballs which do not
 38 
are no longer valid, and only processing built package tarballs which do not
Line 44... Line 43...
44 
repository indexes, particularly in non-strict mode (see Details).
 43 
repository indexes, particularly in non-strict mode (see Details).
45 
}
 44 
}
46 
\details{
 45 
\details{
47 
Throughout this section, \emph{package tarball} is defined to mean any
 46 
Throughout this section, \emph{package tarball} is defined to mean any
48 
archive file in \code{dir} whose name can be interpreted as
 47 
archive file in \code{dir} whose name can be interpreted as
49 
\code{<package>_<version>.<ext>} - with \code{<ext>} the appropriate
 48 
\file{\var{package}_\var{version}.\var{ext}} -- with \var{ext} the appropriate
50 
extension for built packages of type \code{type} - (or that is pointed
 49 
extension for built packages of type \code{type} -- (or that is pointed
51 
to by the \code{File} field of an existing \code{PACKAGES} entry).
 50 
to by the \code{File} field of an existing \code{PACKAGES} entry).
52 
\emph{Novel package tarballs} are those which do not match an existing
 51 
\emph{Novel package tarballs} are those which do not match an existing
53 
\code{PACKAGES} file entry.
 52 
\code{PACKAGES} file entry.
54 
 
 53 
 
55 
\code{update_PACKAGES} calls directly down to
 54 
\code{update_PACKAGES} calls directly down to
56 
\code{\link{write_PACKAGES}} with a warning (and thus all package tarballs
 55 
\code{\link{write_PACKAGES}} with a warning (and thus all package tarballs
57 
will be processed), if any of the following conditions hold:
 56 
will be processed), if any of the following conditions hold:
58 
\itemize{
 57 
\itemize{
59 
  \item \code{type} is \code{win.binary} and \code{strict} is
 58 
  \item \code{type} is \code{"win.binary"} and \code{strict} is
60 
  \code{TRUE} (no MD5 checksums are included in win.binary \code{PACKAGES} files)
 59 
  \code{TRUE} (no MD5 checksums are included in win.binary \code{PACKAGES} files)
61 
  \item No \code{PACKAGES} file exists under \code{dir}
 60 
  \item No \code{PACKAGES} file exists under \code{dir}
62 
  \item A \code{PACKAGES} file exists under \code{dir} but is empty
61 
  \item A \code{PACKAGES} file exists under \code{dir} but is empty
63 
  \item \code{fields} is not \code{NULL} and one or more specified fields
 62 
  \item \code{fields} is not \code{NULL} and one or more specified fields
64 
  are not present in the existing \code{PACKAGES} file
 63 
  are not present in the existing \code{PACKAGES} file
Line 113... Line 112...
113 
to the user. When it is \code{1}, detailed information about what is
 112 
to the user. When it is \code{1}, detailed information about what is
114 
happening is conveyed via messages, but underlying machinery from
 113 
happening is conveyed via messages, but underlying machinery from
115 
\code{\link{write_PACKAGES}} is invoked with \code{verbose = FALSE}.
 114 
\code{\link{write_PACKAGES}} is invoked with \code{verbose = FALSE}.
116 
Behavior when \code{verbose.level} is \code{2} is identical to
 115 
Behavior when \code{verbose.level} is \code{2} is identical to
117 
\code{verbose.level} \code{1} with the exception that underlying
 116 
\code{verbose.level} \code{1} with the exception that underlying
118 
machinery from \code{write_PACKAGE} is invoked with
 117 
machinery from \code{write_PACKAGES} is invoked with
119 
\code{verbose = TRUE}, which will individually list every processed
 118 
\code{verbose = TRUE}, which will individually list every processed
120 
tarball.
 119 
tarball.
121 
}
 120 
}
122 
\note{
 121 
\note{
123 
While both strict and non-strict modes can offer speedups when updating
 122 
While both strict and non-strict modes can offer speedups when updating
Line 132... Line 131...
132 
}
 131 
}
133 
\seealso{
 132 
\seealso{
134 
  \link{write_PACKAGES}
 133 
  \link{write_PACKAGES}
135 
}
134 
}
136 
\author{
 135 
\author{
137 
  Gabriel Becker (adapted from previous, related work by him in the \code{switchr}
 136 
  Gabriel Becker (adapted from previous, related work by him in the \pkg{switchr}
138 
  package which is copyright Genentech, Inc.)
 137 
  package which is copyright Genentech, Inc.)
139 
}
 138 
}
140 
\examples{
 139 
\examples{
141 
\dontrun{
 140 
\dontrun{
142 
write_PACKAGES("c:/myFolder/myRepository") # on Windows
 141 
write_PACKAGES("c:/myFolder/myRepository") # on Windows