Jeff Bezos
Jeff Bezos

Reputation: 2253

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

Upvotes: 0

Views: 105

Answers (1)

Dirk is no longer here
Dirk is no longer here

Reputation: 368241

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.

But I just took one guess at an older package (xts) by a friend and indeed, it has a first entry ending in "-package":

enter image description here

So just add an entry flowNew-package (via roxygen2) and you should be good.

Here is another example from a package of mine:

enter image description here

Upvotes: 1

Related Questions