Date Редакция Категория comp Теги R

Виньетка (vignette) -- это особый вид справки, имеющийся в R. Дело в том, что документация по функциям R весьма обширна, но она будет бесполезна, если вы не знаете, какая именно функция вам нужна. Виньетка же больше похожа на главу в книге или на научную статью, чем на справку. В ней описывается проблема и показано как ее можно решить при помощи данного пакета. Виньетка должна разделить функции пакета на категории, и продемонстрировать, как они взаимодействуют друг с другом в ходе решения задачи. Таким образом, виньетки напоминают юниксовские "howto", с той разницей, что решение проблемы ограничивается средствами одного пакета.

Многие из существующих пакетов имеют виньетки. Увидеть какие виньетки установлены в данный момент на вашей машине можно с помощью функции browseVignettes(). Чтобы увидеть виньетки для конкретного пакета, используйте browseVignettes("имя_пакета"). Каждая виньетка состоит из трех обязательных компонент: исходного файла, читабельной HTML-страницы или PDF-файла и файла исходного кода на R.

Виньетки пакета dplyr

Вы можете прочитать виньетку с помощью функции vignette(х), и посмотреть ее код с помощью edit(vignette(x)).

Подробнее о виньетках и, в частности, о том как их создавать, написано здесь.



Комментарии

comments powered by Disqus