Включение изображения с использованием документации roxygen - PullRequest
17 голосов
/ 05 октября 2011

Можно ли включить изображение в документацию, созданную roxygen? У меня есть несколько функций, которые по сути являются обертками для ggplot (), которые я хотел бы документировать, показывая пример вывода.

1 Ответ

11 голосов
/ 31 октября 2011

Согласно списку изменений из объявления о выпуске R 2.14:

У разметки Rd есть новый тег \ figure, чтобы рисунки могли быть включены в справочные страницы при преобразовании в HTML или LaTeX.На страницах справки есть примеры для par () и points ().

От: http://cran.r -project.org / doc / manual / R-exts.html # Рисунки

Чтобы включить рисунки в справочные страницы, используйте разметку \ figure.Существует три формы.

Двумя обычно используемыми простыми формами являются \ figure {filename} и \ figure {filename} {альтернативный текст}.Это будет включать копию рисунка в выводе HTML или LaTeX.При выводе текста вместо него будет отображаться альтернативный текст.(Если второй аргумент пропущен, будет использовано имя файла.) И имя файла, и альтернативный текст будут проанализированы дословно и не должны содержать специальных символов, значимых в HTML или LaTeX.

Форма экспертаis \ figure {filename} {options: string}.(Слово «options:» должно быть набрано в точности так, как показано, и за ним следует хотя бы один пробел.) В этой форме строка копируется в тег HTML img в качестве атрибутов, следующих за атрибутом src, или во второй аргумент \Макрос рисунка в LaTeX, который по умолчанию используется в качестве опции для вызова \ includegraphics.Поскольку маловероятно, что какой-либо одной строки будет достаточно для обоих режимов отображения, экспертная форма обычно будет заключена в условные выражения.Это зависит от автора, чтобы убедиться, что используется законный HTML / LaTeX.Например, чтобы включить логотип как в HTML (с использованием простой формы), так и в LaTeX (с помощью экспертной формы), можно использовать следующее:

 \if{html}{\figure{logo.jpg}{Our logo}}
 \if{latex}{\figure{logo.jpg}{options: width=0.5in}}

Файлы, содержащие рисунки, должны храниться всправочник человек / цифры.Файлы с расширениями .jpg, .pdf, .png и .svg из этого каталога будут скопированы в каталог help / figure во время установки.(Рисунки в формате PDF не будут отображаться в большинстве браузеров HTML, но могут быть лучшим выбором в справочных руководствах.) Укажите имя файла относительно man / figure в директиве \ figure.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...