Презентация к 10 уроку курса разработка пакетов на языке R

1. Создание сайта
С документацией к пакету
Пакет pkgdown
Алексей Селезнёв

2. Мой telegram канал

3. Рабочий процесс
1. Настройка вашего пакета для создания сайта - usethis::use_pkgdown()
1. Создаёт файл конфигурации сайта _pkgdown.yml
2. Добавляет различные шаблоны в .Rbuildignore, чтобы файлы и каталоги, специфичные для
pkgdown, не включались в сборку вашего пакета.
3. Добавляет docs, место назначения по умолчанию для отображаемого сайта, в .gitignore.
2. Функция pkgdown::build_site() запускает процесс создания сайта
3. Опубликуйте ваш сайт на GitHub командой usethis::use_pkgdown_github_pages():
1. Инициализирует пустую ветку в вашем репозитории GitHub с именем gh-pages
2. Включает GitHub Pages для вашего репозитория
3. Копирует файл конфигурации для GitHub Action, для автоматической пересборки сайта при любом
коммите
4. Добавляет URL-адрес вашего сайта в DESCRIPTION и _pkgdown.yml.

4. Группировка списка документации функций
По умолчанию на странице referenceвашего сайта список функций сортируется по алфавиту,
но вы можете его кастомизироваьт добавив поле reference в файле _pkgdown.yml, указав для
каждого раздела следующие параметры:
• title - название раздела
• subtitle - подзаголовок
• desc – описание раздела
• contents - список названий функций для включения в раздел

5. Организация списка статей
Функция pkgdown::build_articles() создаёт статьи из всех .Rmd файлов, находящихся в папке
vignettes/, за исключением:
• Файлов имена которые начинаются на нижнее подчёркивание (например _index.Rmd)
• Файлы, которые находятся в подкаталоге vignettes/tutorials
Для управления списком статей используйте поле articles в файле _pkgdown.yml, указав для
каждого раздела следующие параметры:
• title - название раздела
• desc – описание раздела
• navbar – пара слов для обозначения этого раздела на панели навигации
• contents - список названий статей для включения в раздел

6. Навигационная панель
За редактирование навигационной панели вашего сайта отвечает поле navbar в файле
_pkgdown.yml. Поле состоит из двух компонентов:
• structure – общий макет навигационной панели, который позволяет редактировать правую и
левую её часть
• сomponents – настройки отдельных компонентов, элементами menu могут быть:
• Ссылка (text+ href)
• Заголовок (text)
• Разделитель (text: ——–)

7. Боковая панель
Боковая панель настраивается через поле home.sidebar:
• links - автоматические ссылки, созданные из полей URL и ссылки прописанные вручную из
полей: BugReports в DESCRIPTION и home.links
• license – информация о лицензии
• community – ссылки на ссылки на .github/CONTRIBUTING.md,
.github/CODE_OF_CONDUCT.mdи т. д.
• citation - ссылка на информацию о цитировании пакета.
• authors – авторы указанные в DESCRIPTION
• dev - значки состояния разработки
• toc – оглавление файла README

8. Тема сайта
Тему сайта можно изменить с помощью поля template. bootswatch, вы можете выбрать любую
из тем указанных в галерее на сайте https://bootswatch.com/

9. Логотип пакета
1. Для начала создайте шестиугольный логотип вашего пакета либо в любом графическом
редакторе, либо с помощью пакета hexSticker.
2. Используйте функцию usethis::use_logo():
1. функция помещает копию файла изображения в соответствующем масштабе в man/figures/logo.png
2. даст вам фргмент markdown разметки для добавления логотипа в README файл
3. включит логотип в ваш сайт

10. СПАСИБО ЗА ВНИМАНИЕ