R devtools: документация по пакету на первой странице руководства

#r #documentation #devtools #roxygen2 #manual

#r #Документация #devtools #roxygen2 #руководство

Вопрос:

Как мне devtools::build_manual поместить документацию по пакету на первую страницу руководства?

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

.datatable.aware <- TRUE
 

Вывод: введите описание изображения здесь

Ответ №1:

Я не думаю, что вы можете, и у вас есть свои инструменты. devtools не влияет на то, как base R сопоставляет все записи удаленных рабочих столов в формате PDF.

Но я только что сделал одно предположение о более старом пакете ( xts ) от друга, и действительно, у него есть первая запись, заканчивающаяся на «-package»:

введите описание изображения здесь

Так что просто добавьте запись flowNew-package (через roxygen2 ), и все должно быть хорошо.

Вот еще один пример из моего пакета:

введите описание изображения здесь