Как конвертировать Rd файлы в pdf для пакета, который я создаю в R?

Я пишу пакет в R, и я был бы признателен за пример кода bash для обработки файлов Rd на латекс, а затем в pdf.

Он находится в каталоге ~/mypkg/dev/. Я создал файловую структуру и шаблоны Rd.

from ~/mypkg/dev/man, я пробовал

R CMD Rdconv -o mypkg-package.tex --type=latex mypkg-package.Rd

Создается файл mypkg-package.tex, но

pdflatex mypkg-package.tex

генерирует tex без преамбулы.

Я прочитал документацию в разделе "Написание R-расширений" и "R CMD Rdconv -help" по этому вопросу, но примеров нет.

Спасибо

Ответы

Ответ 1

Здесь есть две проблемы:

Во-первых, команда Rdconv преобразует только один Rd файл за раз; ваш вопрос предполагает, что вы хотите получить полное руководство.

Во-вторых, команда Rd2dvi - ваш друг. Я просто запустил следующее в локальном пакете:

R CMD Rd2dvi --pdf --title='Test of foo' -o /tmp/foo.pdf man/*.Rd

Это должно быть то, о чем вы просили.

Ответ 2

0. Из вопроса, предполагается, что у вас есть .Rd файлы.

Возможно, вы получили эти файлы .Rd через пакет roxygen или другие способы. Вам нужно .pdf вашего пакета. Один из способов сделать это - из командной строки Windows.

1. Откройте командную строку Windows (если возможно, в режиме администратора). Начало - введите "cmd" - (необязательно: щелкните правой кнопкой мыши по появляющейся иконке - Запуск от имени администратора)

2. Перейдите к текущему рабочему каталогу R (его можно найти через "getwd()" в консоли R) в команде propmt. R текущей рабочей папки содержит папку с вашим источником пакета.

cd C:\Users\erdogan\Documents\Revolution

3.. Для аргумента, скажем, папка пакета была вызвана "causfinder". Выполните следующую команду в командной строке Windows:

(убедитесь, что у вас нет какой-либо causfinder.pdf в рабочем каталоге R (возможно, вы получили некоторый R-development-incompatible causfinder.pdf с некоторыми другими способами вне R). Если существует, сначала удалите causfinder.pdf, В противном случае вы получите эту ошибку: "файл" causfinder.pdf "существует, сначала удалите его" )

R CMD Rd2pdf causfinder/

Эта команда выполняет .Rd → LateX → .pdf процесс автоматически. Вы получаете causfinder.pdf в рабочем каталоге R.

Это описано в руководстве по написанию расширений R в разделе "Обработка файлов документации"

Ответ 4

Я создал базовую функцию bash, поэтому я могу просто запустить rdoc из моей командной строки. Он генерирует файлы Rd, создает PDF файл и открывает его. Я использую его только для тестирования, а не для создания окончательной документации. Вы можете добавить его, добавив следующую функцию в ваш .bashrc (или в зависимости от того, какой вы используете) файл

rdoc() {
  echo -e "devtools::document()" | R --no-save
  rm /tmp/rdoc.pdf
  R CMD Rd2pdf -o /tmp/rdoc.pdf man/*.Rd
  open /tmp/rdoc.pdf
}