diff --git a/R/listFiles.R b/R/listFiles.R index 87b780c..a015de8 100644 --- a/R/listFiles.R +++ b/R/listFiles.R @@ -4,7 +4,9 @@ #' This will call the REST API if the caller is not on the same filesystem. #' #' @param path String containing the path to the registered (sub)directory. -#' @inheritParams retrieveDirectory +#' @param url String containing the URL of the SewerRat REST API. +#' @param forceRemote Logical scalar indicating whether to force remote access, +#' even if \code{path} is on the same filesystem as the caller. #' #' @author Aaron Lun #' diff --git a/R/retrieveFile.R b/R/retrieveFile.R index edd2499..c1bea29 100644 --- a/R/retrieveFile.R +++ b/R/retrieveFile.R @@ -1,7 +1,7 @@ #' Retrieve a single file #' #' Retrieve the path to a single file in a registered directory. -#' This will call the REST API if the caller is not on the same filesystem as the registry. +#' This will call the REST API to obtain and cache a copy of the file if the caller is not on the same filesystem. #' #' @param path String containing the absolute path to a file in a registered directory. #' @param forceRemote Logical scalar indicating whether to force remote access. diff --git a/R/retrieveMetadata.R b/R/retrieveMetadata.R index 6213c33..9380909 100644 --- a/R/retrieveMetadata.R +++ b/R/retrieveMetadata.R @@ -3,11 +3,14 @@ #' Retrieve a single metadata entry in a registered directory from the SewerRat API. #' #' @param path String containing the absolute path to a file in a registered directory. -#' @inheritParams retrieveDirectory +#' @param url String containing the URL to the SewerRat REST API. #' #' @author Aaron Lun #' -#' @return String containing the path to the file on the caller's filesystem. +#' @return A named list containing \code{path}, the path to the metadata file; +#' \code{user}, the identity of the owning user; +#' \code{time}, the Unix time at which the file was modified; +#' and \code{metadata}, the loaded metadata, typically as a named list representing a JSON object. #' #' @examples #' info <- startSewerRat() diff --git a/man/listFiles.Rd b/man/listFiles.Rd index 379752c..b4dc89b 100644 --- a/man/listFiles.Rd +++ b/man/listFiles.Rd @@ -9,10 +9,9 @@ listFiles(path, url, forceRemote = FALSE) \arguments{ \item{path}{String containing the path to the registered (sub)directory.} -\item{url}{String containing the URL to the SewerRat REST API.} +\item{url}{String containing the URL of the SewerRat REST API.} -\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{forceRemote}{Logical scalar indicating whether to force remote access, even if \code{path} is on the same filesystem as the caller.} } \value{ diff --git a/man/retrieveFile.Rd b/man/retrieveFile.Rd index 48a329e..138af3b 100644 --- a/man/retrieveFile.Rd +++ b/man/retrieveFile.Rd @@ -27,7 +27,7 @@ String containing the path to the file on the caller's filesystem. } \description{ Retrieve the path to a single file in a registered directory. -This will call the REST API if the caller is not on the same filesystem as the registry. +This will call the REST API to obtain and cache a copy of the file if the caller is not on the same filesystem. } \examples{ info <- startSewerRat() diff --git a/man/retrieveMetadata.Rd b/man/retrieveMetadata.Rd index ef07886..473cf97 100644 --- a/man/retrieveMetadata.Rd +++ b/man/retrieveMetadata.Rd @@ -12,7 +12,10 @@ retrieveMetadata(path, url) \item{url}{String containing the URL to the SewerRat REST API.} } \value{ -String containing the path to the file on the caller's filesystem. +A named list containing \code{path}, the path to the metadata file; +\code{user}, the identity of the owning user; +\code{time}, the Unix time at which the file was modified; +and \code{metadata}, the loaded metadata, typically as a named list representing a JSON object. } \description{ Retrieve a single metadata entry in a registered directory from the SewerRat API.