Improved documentation for various functions.

ArtifactDB · Apr 22, 2024 · 7fa0c07 · 7fa0c07
1 parent 3d043ad
commit 7fa0c07
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 20 deletions.
diff --git a/R/fetchDirectory.R b/R/fetchDirectory.R
@@ -8,11 +8,15 @@
 #' @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.
+#' This will download all files in the \code{path} via the REST API and cache them locally,
+#' even if \code{registry} is on the same filesystem as the caller.
 #' @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
@@ -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/R/listProjects.R b/R/listProjects.R
@@ -6,7 +6,7 @@
 #' @param registry String containing a path to the registry.
 #' @param url String containing the URL to the Gobbler REST API.
 #' @param forceRemote Logical scalar indicating whether to force remote access via the API,
-#' even if \code{registry} is accessible to the caller. 
+#' even if \code{registry} is on the same filesystem as the caller. 
 #'
 #' @author Aaron Lun
 #'

diff --git a/man/fetchDirectory.Rd b/man/fetchDirectory.Rd
diff --git a/man/fetchLatest.Rd b/man/fetchLatest.Rd
diff --git a/man/fetchManifest.Rd b/man/fetchManifest.Rd
diff --git a/man/fetchPermissions.Rd b/man/fetchPermissions.Rd
diff --git a/man/fetchSummary.Rd b/man/fetchSummary.Rd
diff --git a/man/fetchUsage.Rd b/man/fetchUsage.Rd
diff --git a/man/listAssets.Rd b/man/listAssets.Rd
diff --git a/man/listFiles.Rd b/man/listFiles.Rd
diff --git a/man/listProjects.Rd b/man/listProjects.Rd
diff --git a/man/listVersions.Rd b/man/listVersions.Rd