Citando articoli usando roxygen2

Question

Come in this question, vorrei includere citazioni agli articoli nella documentazione della funzione. Io uso roxygen2 per tutta la documentazione, e sembra che ci sia uncon roxygen2 con le funzionalità necessarie, ma Hadley lo ha spento dal roxygen2 era in modalità di manutenzione. Sono cambiate le cose da allora? C'è un altro modo per citare/includere riferimenti agli articoli archiviati in formato BibTeX?

Answer 1

Il Rdpack package promette di fornire la funzionalità richiesta.

per avere istituito, è inoltre necessario aggiungere la riga RdMacros: Rdpack al file del pacchetto DESCRIPTION (notare la M maiuscola), e aggiungere Rdpack al campo Imports:.

quindi è possibile salvare la libreria bibtex a inst/REFERENCES.bib, e li cita nella documentazione con:

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

Inizialmente ho incontrato alcuni errori al primo utilizzo del pacchetto; Riavviare R sembrava fare il trucco. saranno incontrati

avvertenze circa unknown macro '\insertRef' se la costruzione di documentazione con devtools::document(), come devtools non legge riga del file descrizione Il 'RdMacros'; possono essere tranquillamente ignorati. I riferimenti potrebbero non essere resi correttamente da devtools, ma lo saranno quando il pacchetto sarà finalmente compilato; per visualizzarli nella loro corretta formattazione nel frattempo è possibile eseguire R CMD Rd2pdf da una finestra di comando separata.