Merge pull request #77 from jmbarbone/70-set-note

add `set_note()`

NAMESPACE

@@ -213,6 +213,7 @@ export(save_source)
 export(select_na_cols)
 export(set_names0)
 export(set_not_available)
+export(set_note)
 export(shell_exec)
 export(simpleTimeReport)
 export(smallest_file)

R/note.R

@@ -10,16 +10,17 @@
 #' The type of object assigned to the note is not restricted, so user beware of
 #' odd prints or additional features added to the notes fun.
 #'
-#' When assigning a note (with `note<-`) the `noted` class is added to the
-#' object.  This allows the `print.noted` class to be dispatched and for the
-#' note to be printed every time the object is called/printed and the next print
-#' method used.  However, it will not be called when not `interactive()`
+#' When assigning a note (with `note<-`, and its alias `set_note()`) the `noted`
+#' class is added to the object.  This allows the `print.noted` class to be
+#' dispatched and for the note to be printed every time the object is
+#' called/printed and the next print method used.  However, it will not be
+#' called when not `interactive()`
 #'
 #' @param x An object
 #' @param value The note to attach; if `NULL` will remove the note and the class
 #'   `noted` from the object.
 #' @return
-#' * `note<-` will return `x` (with the `"note"` attribute assigned)
+#' * `note<-`, `set_note()` will return `x` (with the `"note"` attribute assigned)
 #' * `note()` will retrieve the `"note"` attribute
 #'
 #' @examples
@@ -63,6 +64,10 @@
   x
 }
 
+#' @export
+#' @rdname note
+set_note <- `note<-`
+
 #' @export
 #' @rdname note
 note <- function(x) {

tests/testthat/test-note.R

@@ -26,6 +26,11 @@ test_that("note() work", {
   note(x) <- NULL
   expect_null(attr(x, "note"))
   expect_identical(class(x), "character")
+
+  x <- "x"
+  y <- set_note(x, "this note")
+  note(x) <- "this note"
+  expect_identical(x, y)
 })
 
 test_that("print.noted() passes to next methods [67]", {