Cytowanie artykułów przy użyciu roxygen2

Question

Podobnie jak w przypadku this question, chciałbym dołączyć cytowania do artykułów w dokumentacji funkcji. Używam roxygen2 dla całej dokumentacji i wydaje się, że było pull request do roxygen2 z niezbędną funkcjonalnością, ale Hadley odrzucił go, ponieważ roxygen2 był w trybie konserwacji. Czy od tego czasu wszystko się zmieniło? Czy istnieje inny sposób cytowania/dołączania odniesień do artykułów przechowywanych w formacie BibTeX?

Answer 1

The Rdpack package obiecuje dostarczyć żądaną funkcjonalność.

Aby skonfigurować, trzeba także dodać linię RdMacros: Rdpack do swojej paczki DESCRIPTION pliku (należy zwrócić uwagę na kapitał M) i dodać Rdpack pola Imports:.

Następnie można zapisać swoją bibliotekę BibTeX do inst/REFERENCES.bib i cytują je w swojej dokumentacji z:

#' @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 

początkowo napotkał pewne błędy przy pierwszym użyciu pakietu; ponowne uruchomienie R wydawało się, że to wystarczy.

Ostrzeżenia dotyczące unknown macro '\insertRef' zostaną napotkane, jeśli dokumentacja budowlana z devtools::document(), ponieważ devtools nie odczytuje wiersza "RdMacros" pliku DESCRIPTION; mogą być bezpiecznie zignorowane. Referencje mogą nie być poprawnie renderowane przez devtools, ale będą miały miejsce, gdy pakiet zostanie ostatecznie zbudowany; aby wyświetlić je w odpowiednim formacie, możesz uruchomić R CMD Rd2pdf z osobnego okna poleceń.