Как и в этот вопрос, я хотел бы включить цитаты в статьи в функциональную документацию. Я использую roxygen2 для всей документации, и кажется, что существует тянуть запрос до roxygen2 с необходимой функциональностью, но Хэдли повернул его вниз, так как roxygen2 находился в режиме обслуживания. С того времени все изменилось? Есть ли другой способ цитирования/включения ссылок на статьи, хранящихся в формате BibTeX?
Цитирование статей с использованием roxygen2
Ответ 1
пакет Rdpack promises, чтобы предоставить запрошенную функциональность.
Чтобы настроить, вам также нужно добавить строку 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 из отдельного окна команд.