create man pages for cfactor and interlaced attribute setters

khusmann · Jun 17, 2024 · 97a0f84 · 97a0f84
1 parent 3fd51fa
commit 97a0f84
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 11 deletions.
diff --git a/R/cfactor.R b/R/cfactor.R
@@ -117,8 +117,13 @@ codes.default <- function(x, ...) {
   attr(attr(x, "levels"), "codes")
 }
 
-#' @rdname codes
+#' Set the codes for a `cfactor``
+#'
+#' Set the codes for a `cfactor`, similar to `levels<-()`
+#'
 #' @keywords internal
+#' @param value a named vector of codes for the `cfactor`
+#'
 #' @export
 `codes<-` <- function(x, value) {
   UseMethod("codes")

diff --git a/R/interlaced.R b/R/interlaced.R
@@ -493,6 +493,9 @@ levels.interlacer_interlaced <- function(x) {
   levels(value_channel(x))
 }
 
+#' Set the factor level attributes of `interlaced` vectors
+#' @keywords internal
+#' @param value A vector of new levels to set
 #' @export
 `levels<-.interlacer_interlaced` <- function(x, value) {
   map_value_channel(x, \(v) `levels<-`(v, value))
@@ -504,8 +507,7 @@ na_levels <- function(x) {
   levels(na_channel(x))
 }
 
-#' @rdname levels.interlacer_interlaced
-#' @keywords internal
+#' @rdname levels-set-.interlacer_interlaced
 #' @export
 `na_levels<-` <- function(x, value) {
   map_na_channel(x, \(v) `levels<-`(v, value))

diff --git a/man/codes-set.Rd b/man/codes-set.Rd
diff --git a/man/codes.Rd b/man/codes.Rd
diff --git a/man/levels-set-.interlacer_interlaced.Rd b/man/levels-set-.interlacer_interlaced.Rd
diff --git a/man/levels.interlacer_interlaced.Rd b/man/levels.interlacer_interlaced.Rd