Artikel mit roxygen2 zitieren

Question

Wie in this question, würde ich gerne Zitate zu Artikeln in der Funktionsdokumentation einfügen. Ich benutze roxygen2 für die gesamte Dokumentation, und es scheint, dass es eine pull request zu roxygen2 mit der notwendigen Funktionalität gab, aber Hadley lehnte es ab, da roxygen2 im Wartungsmodus war. Haben sich die Dinge seitdem geändert? Gibt es eine andere Möglichkeit, im BibTeX-Format gespeicherte Artikelverweise zu zitieren/aufzunehmen?

Answer 1

Die Rdpack package verspricht die von Ihnen gewünschte Funktionalität zu liefern.

einrichten zu erhalten, müssen Sie auch die Linie RdMacros: Rdpack zu Ihrem Paket der DESCRIPTION Datei (beachten Sie die Hauptstadt M) und Rdpack Feld zum Imports: hinzufügen hinzuzufügen.

Dann können Sie Ihre bibtex Bibliothek in zu inst/REFERENCES.bib speichern und nennen Sie sie in Ihrer Dokumentation mit:

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

begegnete ich zunächst einige Fehler, wenn zunächst das Paket verwendet wird; Re-Start R schien den Trick zu machen.

Warnungen über unknown macro '\insertRef' werden bei der Erstellung der Dokumentation mit devtools::document() auftreten, da Devtools die 'RdMacros' Zeile der Datei DESCRIPTION nicht liest; Sie können sicher ignoriert werden. Die Verweise werden möglicherweise nicht korrekt von Devtools gerendert, aber wenn das Paket schließlich erstellt wird; um sie zwischenzeitlich in ihrer korrekten Formatierung anzuzeigen, können Sie R CMD Rd2pdf von einem separaten Befehlsfenster ausführen.