-
Notifications
You must be signed in to change notification settings - Fork 0
/
metadata2-methods.R
136 lines (116 loc) · 2.92 KB
/
metadata2-methods.R
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#' Metadata
#'
#' Dynamically handles metadata assignment and extraction in a similar fashion
#' for both S3 and S4 objects.
#'
#' @name metadata2
#' @note Updated 2021-10-14.
#'
#' @section S3 class:
#'
#' Internally slots into `attributes()`.
#' Attribute is also accessible via `attr(object, which)`.
#'
#' @section S4 class:
#'
#' Requires that object extends `Annotated` class.
#' Internally slots into `metadata()`.
#' Attribute is also accessible via `metadata(object)[[which]]`.
#'
#' @inheritParams AcidRoxygen::params
#' @param ... Additional arguments.
#'
#' @param which `character(1)`.
#' A non-empty character string specifying which attribute is to be accessed.
#' Note that positional `numeric` arguments are currently not allowed.
#'
#' @param value `ANY`.
#' Metadata values to assign into slot, defined by `which`.
#'
#' @return
#' - `metadata2()`: Metadata. Returns `NULL` on `which` match failure, similar
#' to `attr()` and `metadata()`.
#' - `metadata2<-()`: Modified object.
#'
#' @examples
#' ## S3 ====
#' x <- data.frame()
#' metadata2(x, which = "A") <- "B"
#' metadata2(x, which = "A")
#' attr(x, which = "A")
#'
#' ## S4 (extending Annotated) ====
#' x <- S4Vectors::DataFrame()
#' metadata2(x, which = "A") <- "B"
#' metadata2(x, which = "A")
NULL
## Intended for S3 class, or S4 class that doesn't support `metadata()`.
## Updated 2019-10-24.
`metadata2,ANY` <- # nolint
function(x, which) {
assert(isString(which))
attr(x = x, which = which, exact = TRUE)
}
## Intended for S4 class supporting `metadata()`.
## Updated 2019-10-24.
`metadata2,Annotated` <- # nolint
function(x, which) {
assert(isString(which))
metadata(x)[[which]]
}
## Intended for S3 class, or S4 class that doesn't support `metadata()`.
## Updated 2019-10-24.
`metadata2<-,ANY,ANY` <- # nolint
function(x, which, value) {
attr(x = x, which = which) <- value
x
}
## Intended for S3 class, or S4 class that doesn't support `metadata()`.
## Updated 2019-10-24.
`metadata2<-,Annotated,ANY` <- # nolint
function(x, which, value) {
metadata(x)[[which]] <- value
x
}
#' @rdname metadata2
#' @export
setMethod(
f = "metadata2",
signature = signature(
x = "ANY",
which = "character"
),
definition = `metadata2,ANY`
)
#' @rdname metadata2
#' @export
setMethod(
f = "metadata2",
signature = signature(
x = "Annotated",
which = "character"
),
definition = `metadata2,Annotated`
)
#' @rdname metadata2
#' @export
setReplaceMethod(
f = "metadata2",
signature = signature(
x = "ANY",
which = "character",
value = "ANY"
),
definition = `metadata2<-,ANY,ANY`
)
#' @rdname metadata2
#' @export
setReplaceMethod(
f = "metadata2",
signature = signature(
x = "Annotated",
which = "character",
value = "ANY"
),
definition = `metadata2<-,Annotated,ANY`
)