记录 ggplot2 统计扩展 - devtools::document() 不创建 packagename-ggproto.Rd

Question

我正在创建一个包，其中将包含一个新的 ggplot2 统计数据。

我正在使用 ggplot2::ggproto 创建新的统计数据，但我在使用 roxygen2 的文档时遇到了问题。在运行devtools::document()之后，我得到：

mypackagename-ggproto.Rd is missing name/title. Skipping

我尝试按照其他软件包的示例（例如 here, here, and here）进行操作，但我遇到了同样的问题。作为最小的可重现示例，我提供了我的 stat-test.R 文件的以下内容：

#' @title My Statistic
#'
#' @description blah blah
#'
#' @param ... other arguments.
#' @param na.rm a logical value indicating ...
#'
#' @export
#' 
stat_test <- function(mapping = NULL, data = NULL, geom = "segment", 
                     position = "identity", na.rm = FALSE, 
                     linetype="dotted", show.legend = NA, 
                     inherit.aes = TRUE, ...) {
  ggplot2::layer(
    stat = StatTEST, 
    data = data, 
    mapping = mapping, 
    geom = geom, 
    position = position, 
    show.legend = show.legend, 
    inherit.aes = inherit.aes,
    params = list(na.rm = na.rm, linetype = linetype, ...)
  )
}

#' @rdname mypackagename-ggproto
#' @format NULL
#' @usage NULL
#' @export
StatTEST <- ggplot2::ggproto("StatTEST", ggplot2::Stat,
                       compute_group = function(data, scales, ...) {
                         ## Compute the line segment endpoints

                         data[nrow(data), c("from", "to")] <- 
                           c(
                             data[1, "from"], data[1, "to"]
                             )

                         x = data[data$from, 1]
                         y = data[data$from, 2]
                         xend = data[data$to, 1]
                         yend = data[data$to, 2]

                         data.frame(x=x, y=y, xend=xend, yend=yend)

                       },
                       required_aes = c("x", "y", "from", "to")
 )

我也阅读了 roxygen2 Generating Rd Files 小插图，但找不到解决方案。我不明白为什么 #' @rdname mypackagename-ggproto 没有生成我的 mypackagename-ggproto.Rd 文件。

如有任何帮助，我将不胜感激。

查看信息：

R version 3.5.1 (2018-07-02)
Platform: x86_64-suse-linux-gnu (64-bit)
Running under: openSUSE Leap 15.0

Matrix products: default
BLAS: /usr/lib64/R/lib/libRblas.so
LAPACK: /usr/lib64/R/lib/libRlapack.so

locale:
 [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C               
LC_TIME=en_US.UTF-8        LC_COLLATE=en_US.UTF-8     
LC_MONETARY=en_US.UTF-8   
 [6] LC_MESSAGES=en_US.UTF-8    LC_PAPER=en_US.UTF-8       LC_NAME=C                  
LC_ADDRESS=C               LC_TELEPHONE=C            
[11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
[1] emstreeR_1.0

loaded via a namespace (and not attached):
 [1] Rcpp_0.12.18         pillar_1.3.0         compiler_3.5.1       
plyr_1.8.4           bindr_0.1.1          tools_3.5.1          
digest_0.6.15       
 [8] memoise_1.1.0        tibble_1.4.2         gtable_0.2.0         
pkgconfig_2.0.1      rlang_0.2.1          rstudioapi_0.7       
commonmark_1.5      
[15] yaml_2.2.0           bindrcpp_0.2.2       withr_2.1.2          
dplyr_0.7.6          stringr_1.3.1        roxygen2_6.1.0       xml2_1.2.0          
[22] desc_1.2.0           devtools_1.13.6      rprojroot_1.3-2      
grid_3.5.1           tidyselect_0.2.4     scatterplot3d_0.3-41 glue_1.3.0          
[29] R6_2.2.2             ggplot2_3.0.0        purrr_0.2.5          
magrittr_1.5         backports_1.1.2      scales_0.5.0         
assertthat_0.2.0    
[36] colorspace_1.3-2     stringi_1.2.4        lazyeval_0.2.1       
munsell_0.5.0        crayon_1.3.4

Answer 1

@rdname 标签将函数的文档与已存在的 doc 文件相关联，但不能用于创建新文档。如果您查看 Generating Rd Files Vignette，您会发现他们总是使用 @rdname 到 link 一个函数的文档到一个现有文件：

在下面的示例中，add 函数被正常记录。通过使用 @rdname add，times 函数将记录在与 add

相同的文件中

#' Basic arithmetic
#'
#' @param x,y numeric vectors.
add <- function(x, y) x + y

#' @rdname add
times <- function(x, y) x * y

如果您不想围绕单个函数构建文档文件，您仍然需要在使用 @rdname 将函数与其相关联之前创建该文件。您可以通过使用 @name 标签创建和记录一个虚拟函数来做到这一点。然后你可以使用 @rdname 在同一个虚拟文件中记录函数：

#' Basic arithmetic
#'
#' @param x,y numeric vectors.
#' @name arith
NULL

#' @rdname arith
add <- function(x, y) x + y

#' @rdname arith
times <- function(x, y) x * y

记录 ggplot2 统计扩展 - devtools::document() 不创建 packagename-ggproto.Rd

Documenting a ggplot2 Statistic extension - devtools::document() is not creating packagename-ggproto.Rd

r

ggplot2

devtools

r-package

roxygen2