Документирование функций сеттера с помощью roxygen

Question

У меня есть функция, которая не делает ничего, кроме объявления уникального attr для любого объекта R.Базовая демонстрация:

#' Setter function
#' @param x an R object
#' @param value a character value to set
#' @export
`foo<-` <- function(x, value){
    attr(x, 'foo') <- value
    return(x)
}

Это работает как талисман, за исключением генерации хорошего Rd-файла, соответствующая часть:

\usage{
  foo(var, value) <- value
}

И, конечно, выдает предупреждение при запуске R CMD check какэто должно быть foo(var) <- value.

Любые подсказки были бы очень полезны!

---

Обновление : благодаря richierocks кажется, что есть исправление

Answer 1

Вы можете использовать тег roxygen @usage

Вот пример из одного из моих пакетов:

#' @rdname pattern
#' @usage pattern(x) <- value
#' @param value New value
#' @export pattern<-
"pattern<-" <- function(x, value=c("^", "($|(_\\d+(_\\d+)*)$)")){
  attr(x, "pattern") <- value
  x
}

---

Это приводит к моей желаемой документации:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value