r - 从 R6 方法继承 Roxygen 文档

Question

如何从 R6 方法继承 roxygen 文档？以下代码（稍微更改了Roxygen R6 文档示例）

#' R6 Class representing a person
#'
#' A person has a name and a hair color.
Person <- R6::R6Class("Person",
                      public = list(
                        #' @field name First or full name of the person.
                        name = NULL,

                        #' @field hair Hair color of the person.
                        hair = NULL,

                        #' @description
                        #' Create a new person object.
                        #' @param name Name.
                        #' @param hair Hair color.
                        #' @return A new `Person` object.
                        initialize = function(name = NA, hair = NA) {
                          self$name <- name
                          self$hair <- hair
                          self$greet()
                        },

                        #' @description
                        #' Change hair color.
                        #' @inheritParams Person$initialize
                        #' @examples
                        #' P <- Person("Ann", "black")
                        #' P$hair
                        #' P$set_hair("red")
                        #' P$hair
                        set_hair = function(hair) {
                          self$hair <- hair
                        }
                      )
)

返回警告

Warning: argument `hair` undocumented for R6 method `set_hair()`
Warning message:
Topic 'Person': no parameters to inherit with @inheritParams 

我尝试了一些不同的方法来引用 R6 方法，但它们中的任何一个都有效。甚至可能吗？

标签： rroxygen2r6