Цитирование статей с использованием roxygen2

Question

Как и в this question, я хотел бы включить цитаты в статьи в функциональную документацию. Я использую roxygen2 для всей документации, и кажется, что был pull request до roxygen2 с необходимой функциональностью, но Хэдли отказался, так как roxygen2 находился в режиме обслуживания. С того времени все изменилось? Есть ли другой способ цитирования/включения ссылок на статьи, хранящихся в формате BibTeX?

Answer 1

Rdpack package обещает предоставить запрошенные функциональные возможности.

Чтобы установить, вам также необходимо добавить строку RdMacros: Rdpack к DESCRIPTION файла вашего пакета (обратите внимание на капитал M), и добавить Rdpack в Imports: поле.

Затем вы можете сохранить вашу библиотеку BibTeX, чтобы inst/REFERENCES.bib, и приводить их в документации с:

#' @references{ 
#' \insertRef{bibtexKey}{YourPackageName} 
#' } 
#' 
#' # The below line ought to be included in at least one of your documentation 
#' # sections, so that roxygen2 adds Rdpack to your NAMESPACE file. 
#' 
#' @importFrom Rdpack reprompt 

я первоначально возникли некоторые ошибки при первом использовании пакета; повторный запуск R, похоже, сделал трюк.

Предупреждения о unknown macro '\insertRef' будут обнаружены при строительной документации с devtools::document(), так как devtools не читает строку «RdMacros» файла DESCRIPTION; их можно безопасно игнорировать. Ссылки могут быть неправильно обработаны devtools, но будут, когда пакет окончательно построен; чтобы просмотреть их при правильном форматировании, вы можете запустить R CMD Rd2pdf из отдельного окна команд.