1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
#' Create a redirection file
#'
#' \emph{WARNING: this function is deprecated.
#' Redirection is no longer supported in the latest \pkg{alabaster} framework.}
#' Create a redirection to another path in the same staging directory.
#' This is useful for creating short-hand aliases for resources that have inconveniently long paths.
#'
#' @param dir String containing the path to the staging directory.
#' @param src String containing the source path relative to \code{dir}.
#' @param dest String containing the destination path relative to \code{dir}.
#' This may be any path that can also be used in \code{\link{acquireMetadata}}.
#'
#' @return A list of metadata that can be processed by \code{\link{writeMetadata}}.
#'
#' @details
#' \code{src} should not correspond to an existing file inside \code{dir}.
#' This avoids ambiguity when attempting to load \code{src} via \code{\link{acquireMetadata}}.
#' Otherwise, it would be unclear as to whether the user wants the file at \code{src} or the redirection target \code{dest}.
#'
#' \code{src} may correspond to existing directories.
#' This is because directories cannot be used in \code{acquireMetadata}, so no such ambiguity exists.
#'
#' @author Aaron Lun
#' @examples
#' # Staging an example DataFrame:
#' library(S4Vectors)
#' df <- DataFrame(A=1:10, B=LETTERS[1:10])
#' tmp <- tempfile()
#' dir.create(tmp)
#' info <- stageObject(df, tmp, path="coldata")
#'writeMetadata(info, tmp)
#'
#' # Creating a redirection:
#' redirect <- createRedirection(tmp, "foobar", "coldata/simple.csv.gz")
#'writeMetadata(redirect, tmp)
#'
#' # We can then use this redirect to pull out metadata:
#' info2 <- acquireMetadata(tmp, "foobar")
#' str(info2)
#'
#' @export
#' @aliases .createRedirection
createRedirection <- function(dir, src, dest) {
json <- paste0(src, ".json")
if (file.exists(file.path(dir, json))) {
stop("cannot create a short-hand link over existing file '", json, "'")
}
list(
path = src,
`$schema` = "redirection/v1.json",
redirection = list(
targets = list(
list(
type = "local",
location = dest
)
)
)
)
}
# Soft-deprecated back-compatibility fixes.
#' @export
.createRedirection <- function(...) createRedirection(...)
|
