Skip to content

Commit

Permalink
reference
Browse files Browse the repository at this point in the history
  • Loading branch information
wlandau committed Aug 28, 2024
1 parent 6315511 commit 4fe9da7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
6 changes: 6 additions & 0 deletions R/tar_repository_cas.R
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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.
Expand All @@ -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.
Expand Down
12 changes: 9 additions & 3 deletions man/tar_repository_cas.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4fe9da7

Please sign in to comment.