我正在尝试创建一些脚本的文档,其中包含一些R6类。作为示例,我从此处使用名为“ Person”的R6Class:https://www.tidyverse.org/blog/2019/11/roxygen2-7-0-0/
我正在使用此功能https://stackoverflow.com/a/59073260/12166017来创建文档,而无需创建软件包。是否也可以将其用于R6Classes,或者还有另一种方法可以实现此目的?使用上述功能,我总是会收到错误R6 Class (Person) without source references.
官方tidyverse博客https://www.tidyverse.org/blog/2019/11/roxygen2-7-0-0/的解决方案无法将Roxygen: list(r6 = FALSE)
写入DESCRIPTION文件,因为我没有软件包,因此也没有DESCRIPTION文件。
答案 0 :(得分:7)
执行此操作的一种方法是劫持roxygen2的一些未导出函数,以为已记录的R6类创建块对象并编写一个Rd
文件。然后可以使用tools
包对此进行解析并将其写入html。
这是一个非常粗糙的概念证明,要求您的R6定义位于独立文件中,并且不带任何参数来允许保存到特定位置等,但是可以对其进行调整和扩展以适合: / p>
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))
}
因此,如果我们有以下文件,请从您的链接中获取:
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”相同的目录中: