Каковы стандартные параметры для создания печатной документации для пакета R?

Question

Когда я просматриваю документацию для пакетов R, она часто приходит в виде документа PDF, например:

https://cran.r -project.org / web / packages / glmnet / glmnet.pdf

У этого документа есть имя?

Обычно я нахожу эти документы при поиске в Интернете, но мне интересно, могу ли я также создать их с помощью некоторой команды R, например library(help=...) или vignette(...).Тем не менее, этот ответ делает его звучащим несколько сложным, как будто я должен сам скомпилировать пакет и запустить R CMD Rd2pdf, это правильно?

Также, как предполагаемый автор пакета, я мог быпредставьте себе, что этот PDF документ служит основной документацией для моего пакета.Единственное препятствие - когда я читаю эти документы, документированные функции всегда отображаются в алфавитном порядке.Есть ли способ поставить самые важные функции на первое место, чтобы документ можно было прочитать напрямую (а не просто как ссылку)?Или есть другой формат документации, который позволит мне документировать вещи в определенном порядке?

Answer 1

Справочное руководство - это просто набор справочных страниц. Они должны быть написаны как справочные материалы, что, вероятно, не первое место, где пользователь должен искать документацию, если вы это подразумеваете под «первичной документацией».

Первое, на что должны обратить внимание пользователи, это виньетка, в которой представлен обзор пакета. Он может отображаться в формате HTML или PDF (выбор зависит от автора пакета). Поскольку это произвольная форма, вы можете задокументировать вещи в логическом порядке, вы не ограничены алфавитным порядком справочного руководства.

Это также необязательно, и я использую его как показатель качества исследуемого пакета: если у них нет такой виньетки, авторам действительно нет дела до предоставления хорошей документации.