简体   繁体   English

R 开发工具:手册第一页上的 package 文档

[英]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?如何制作devtools::build_manual将 package 文档放在手册的第一页?

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

.datatable.aware <- TRUE

Output: Output: 在此处输入图像描述

I do not think you can, and you have your tools crossed.我认为你不能,而且你的工具已经过时了。 devtools does not influence how base R collates all Rd entries into a pdf. devtools不会影响基础 R 如何将所有 Rd 条目整理到 pdf 中。

But I just took one guess at an older package ( xts ) by a friend and indeed, it has a first entry ending in "-package":但是我只是猜测了一个朋友的旧 package ( xts ) ,实际上,它的第一个条目以“-package”结尾:

在此处输入图像描述

So just add an entry flowNew-package (via roxygen2 ) and you should be good.所以只需添加一个条目flowNew-package (通过roxygen2 ),你应该很好。

Here is another example from a package of mine :这是我的 package 的另一个示例:

在此处输入图像描述

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM