diff --git a/R/fetchDirectory.R b/R/fetchDirectory.R index 15426f1..fa20d78 100644 --- a/R/fetchDirectory.R +++ b/R/fetchDirectory.R @@ -8,11 +8,14 @@ #' @param registry String containing a path to the registry. #' @param url String containing the URL to the Gobbler REST API. #' @param cache String containing a path to a cache directory. -#' If \code{NULL}, an appropriate cache is automatically chosen. +#' If \code{NULL}, an appropriate location is automatically chosen. +#' Only used for remote access. #' @param forceRemote Logical scalar indicating whether to force remote access. #' This will download all files in the \code{path} via the REST API and cache them locally. #' @param overwrite Logical scalar indicating whether to overwrite the existing cache. +#' Only used for remote access. #' @param concurrent Integer specifying the number of concurrent downloads. +#' Only used for remote access. #' #' @return Path to the subdirectory on the caller's filesystem. #' This is either a path to the registry if it is accessible, diff --git a/R/fetchManifest.R b/R/fetchManifest.R index 26f304d..8e9d415 100644 --- a/R/fetchManifest.R +++ b/R/fetchManifest.R @@ -18,6 +18,7 @@ #' \item \code{md5sum}, a string containing the hex-encoded MD5 checksum of the file. #' \item \code{link} (optional): a list specifying the link destination for a file. #' This contains the strings \code{project}, \code{asset}, \code{version} and \code{path}. +#' If the link destination is itself a link, an \code{ancestor} list will be present that specifies the final location of the file after resolving all intermediate links. #' } #' #' @examples diff --git a/man/fetchDirectory.Rd b/man/fetchDirectory.Rd index f9eb65a..b775e8f 100644 --- a/man/fetchDirectory.Rd +++ b/man/fetchDirectory.Rd @@ -23,14 +23,17 @@ This usually takes the form of \code{PROJECT/ASSET/VERSION/*}.} \item{url}{String containing the URL to the Gobbler REST API.} \item{cache}{String containing a path to a cache directory. -If \code{NULL}, an appropriate cache is automatically chosen.} +If \code{NULL}, an appropriate location is automatically chosen. +Only used for remote access.} \item{forceRemote}{Logical scalar indicating whether to force remote access. This will download all files in the \code{path} via the REST API and cache them locally.} -\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache.} +\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache. +Only used for remote access.} -\item{concurrent}{Integer specifying the number of concurrent downloads.} +\item{concurrent}{Integer specifying the number of concurrent downloads. +Only used for remote access.} } \value{ Path to the subdirectory on the caller's filesystem. diff --git a/man/fetchManifest.Rd b/man/fetchManifest.Rd index 1c08c8b..30d58b6 100644 --- a/man/fetchManifest.Rd +++ b/man/fetchManifest.Rd @@ -27,12 +27,14 @@ fetchManifest( \item{url}{String containing the URL to the Gobbler REST API.} \item{cache}{String containing a path to a cache directory. -If \code{NULL}, an appropriate cache is automatically chosen.} +If \code{NULL}, an appropriate location is automatically chosen. +Only used for remote access.} \item{forceRemote}{Logical scalar indicating whether to force remote access. This will download all files in the \code{path} via the REST API and cache them locally.} -\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache.} +\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache. +Only used for remote access.} } \value{ List containing the manifest for this version. @@ -43,6 +45,7 @@ The value of each element is another list with the following fields: \item \code{md5sum}, a string containing the hex-encoded MD5 checksum of the file. \item \code{link} (optional): a list specifying the link destination for a file. This contains the strings \code{project}, \code{asset}, \code{version} and \code{path}. +If the link destination is itself a link, an \code{ancestor} list will be present that specifies the final location of the file after resolving all intermediate links. } } \description{ diff --git a/man/fetchSummary.Rd b/man/fetchSummary.Rd index 4f4b01e..98c4b38 100644 --- a/man/fetchSummary.Rd +++ b/man/fetchSummary.Rd @@ -27,12 +27,14 @@ fetchSummary( \item{url}{String containing the URL to the Gobbler REST API.} \item{cache}{String containing a path to a cache directory. -If \code{NULL}, an appropriate cache is automatically chosen.} +If \code{NULL}, an appropriate location is automatically chosen. +Only used for remote access.} \item{forceRemote}{Logical scalar indicating whether to force remote access. This will download all files in the \code{path} via the REST API and cache them locally.} -\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache.} +\item{overwrite}{Logical scalar indicating whether to overwrite the existing cache. +Only used for remote access.} } \value{ List containing the summary for this version, with the following fields: