首页 > 解决方案 > R devtools: package documentation on first page of the manual

问题描述

How do I make devtools::build_manual put package documentation on the first page of the manual?

#' flowNet: Mapping the Topology of Single Cell Data
#'
#' Some text...
#'
#' @section Some more text...
#'
#' @docType package
#' @name flowNet
NULL
#> NULL

.datatable.aware <- TRUE

Output: enter image description here

标签: rdocumentationdevtoolsroxygen2manual

解决方案


我不认为你可以,而且你的工具已经过时了。devtools不影响 base R 如何将所有 Rd 条目整理成 pdf。

但我只是猜测了一个朋友的旧包(xts,事实上,它有一个以“-package”结尾的第一个条目:

在此处输入图像描述

所以只需添加一个条目flowNew-package(通过roxygen2),你应该很好。

这是我的一个包中的另一个示例:

在此处输入图像描述


推荐阅读