Tidied up docs for the new functions.

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
 #'

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.

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()