为不在包中的 R6 类创建 Rd 文档文件

Question

我正在尝试为一些包含 R6 类的脚本创建文档。作为示例，我使用此处名为“Person”的 R6Class：https://www.tidyverse.org/blog/2019/11/roxygen2-7-0-0/

我正在使用此功能创建文档而不需要创建包。是否也可以将它用于 R6Classes 或者是否有另一种方法可以实现这一点？使用上述功能，我总是会收到错误 R6 Class (Person) without source references.

tidyverse官方博客https://www.tidyverse.org/blog/2019/11/roxygen2-7-0-0/在DESCRIPTION文件中写Roxygen: list(r6 = FALSE)的解决方案不行，因为我没有包所以没有DESCRIPTION文件

Answer 1

实现此目的的一种方法是劫持 roxygen2 的一些未导出函数来为记录的 R6 class 创建块对象并编写一个 Rd 文件。然后可以使用 tools 包对其进行解析并写入 html。

这是一个非常粗略的 proof-of-concept，要求你的 R6 定义在一个独立的文件中，并且不带任何参数以允许保存到特定位置等，但它可以进行调整和扩展以适应:

document_R6 <- function(R_file)
{
  blocks  <- lapply(roxygen2:::tokenize_file(R_file), roxygen2:::block_set_env,
                    env = .GlobalEnv)
  blocks  <- roxygen2:::order_blocks(blocks)
  roclet  <- roxygen2:::roclet("rd")
  my_rd   <- suppressWarnings(roxygen2:::roclet_process(roclet, blocks))
  my_rd   <- my_rd[[1]]$format()
  rd_file <- tempfile()
  writeLines(my_rd, rd_file)
  tools::Rd2HTML(tools::parse_Rd(rd_file), 
                 gsub("\.R$", ".html", R_file))
}

因此，如果我们有以下文件，取自您的link：

Person.R

#' 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.
    #' @param val New hair color.
    #' @examples
    #' P <- Person("Ann", "black")
    #' P$hair
    #' P$set_hair("red")
    #' P$hair
    set_hair = function(val) {
      self$hair <- val
    },

    #' @description
    #' Say hi.
    greet = function() {
      cat(paste0("Hello, my name is ", self$name, ".\n"))
    }
  )
)

那么我们可以这样做：

document_R6("Person.R")

以下是生成的“Person.html”文件的屏幕截图，可在与“Person.R”相同的目录中找到：

为不在包中的 R6 类 创建 Rd 文档文件

creating Rd documentation files for R6 classes not in a package

r

function

roxygen2

r6

为不在包中的 R6 类创建 Rd 文档文件