From 4fe9da7102a1ca0ae12109c1e5527757dc3d5744 Mon Sep 17 00:00:00 2001 From: wlandau Date: Wed, 28 Aug 2024 10:49:21 -0400 Subject: [PATCH] reference --- R/tar_repository_cas.R | 6 ++++++ man/tar_repository_cas.Rd | 12 +++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/R/tar_repository_cas.R b/R/tar_repository_cas.R index 863802a5..1200c8f0 100644 --- a/R/tar_repository_cas.R +++ b/R/tar_repository_cas.R @@ -142,6 +142,8 @@ #' method can use [tar_format_get()]. For example, to make #' [tar_repository_cas_local()] efficient, `upload` moves the file #' if `targets::tar_format_get() == "file"` and copies it otherwise. +#' +#' See the "Repository functions" section for more details. #' @param download A function with arguments `key` and `path`, in that order. #' This function should download the data object at `key` from #' the CAS system to the file or directory at `path`. @@ -152,6 +154,8 @@ #' system. If the CAS system is a local file system, for example, #' `download` should copy the file and not simply move it #' (e.g. please avoid `file.rename()`). +#' +#' See the "Repository functions" section for more details. #' @param exists A function with a single argument `key`. #' This function should check if there is an object at `key` in #' the CAS system. @@ -160,6 +164,8 @@ #' New lookups can check the cache and potentially avoid expensive #' queries to the CAS system. See the source code of [tar_cas_e()] #' for an example of how this can work for a local file system CAS. +#' +#' See the "Repository functions" section for more details. #' @param consistent Logical. Set to `TRUE` if the storage platform is #' strongly read-after-write consistent. Set to `FALSE` if the platform #' is not necessarily strongly read-after-write consistent. diff --git a/man/tar_repository_cas.Rd b/man/tar_repository_cas.Rd index f8dcde64..11783d71 100644 --- a/man/tar_repository_cas.Rd +++ b/man/tar_repository_cas.Rd @@ -27,7 +27,9 @@ To differentiate between \code{format = "file"} targets and non-\code{"file"} targets, the \code{upload} method can use \code{\link[=tar_format_get]{tar_format_get()}}. For example, to make \code{\link[=tar_repository_cas_local]{tar_repository_cas_local()}} efficient, \code{upload} moves the file -if \code{targets::tar_format_get() == "file"} and copies it otherwise.} +if \code{targets::tar_format_get() == "file"} and copies it otherwise. + +See the "Repository functions" section for more details.} \item{download}{A function with arguments \code{key} and \code{path}, in that order. This function should download the data object at \code{key} from @@ -38,7 +40,9 @@ the CAS system to the file or directory at \code{path}. Please be careful to avoid deleting the object at \code{key} from the CAS system. If the CAS system is a local file system, for example, \code{download} should copy the file and not simply move it -(e.g. please avoid \code{file.rename()}).} +(e.g. please avoid \code{file.rename()}). + +See the "Repository functions" section for more details.} \item{exists}{A function with a single argument \code{key}. This function should check if there is an object at \code{key} in @@ -47,7 +51,9 @@ the CAS system. For efficiency, \code{exists} can maintain an in-memory cache of keys. New lookups can check the cache and potentially avoid expensive queries to the CAS system. See the source code of \code{\link[=tar_cas_e]{tar_cas_e()}} -for an example of how this can work for a local file system CAS.} +for an example of how this can work for a local file system CAS. + +See the "Repository functions" section for more details.} \item{consistent}{Logical. Set to \code{TRUE} if the storage platform is strongly read-after-write consistent. Set to \code{FALSE} if the platform