2016-01-22 12 views
13

Esiste un modo per includere collegamenti tra pacchetti di vignette in R? So che posso legame tra la sezione, per esempioCollegamento del pacchetto R vignette

# Section 1 {#section1} 
My first section 

# Section 2 
A link to [Section 1](#section1) 

ma c'è un modo per ottenere un link cliccabile che lancerà il doucment HTML di un'altra vignetta? O è semplicemente più semplice dare il codice per avviarlo?

```r 
vignette("my vignette", package = "myPackage") 
``` 

Nota ho generato tutte le mie vignette utilizzando Rmarkdown e knitr.

risposta

15

Sì, questo è semplice. Le vignette sono tutte memorizzate nella stessa directory, quindi è sufficiente fare riferimento al nome file appropriato. Il pacchetto drat vignettes ha diversi esempi di questo. Ecco un link da una vignetta all'altra:

This vignette deals with the first case: How to use 
[drat](http://dirk.eddelbuettel.com/code/drat.html) as a package author. A 
[companion vignette for package users](DratForPackageUsers.html) is available as well. 

questo funzionerà su CRAN e sulla macchina di un utente.

Dovresti anche essere in grado di collegare dalle vignette alla documentazione, e viceversa, sulla macchina di un utente, sapendo che le vignette sono memorizzate in library/PKGNAME/doc/ e la documentazione è memorizzata in: library/PKGNAME/html/.

+0

Sì, funziona. Fantastico. Grazie mille - mi mancava il '.html' che era il motivo per cui non riuscivo a farlo funzionare da solo. – nathaneastwood

+1

Penso che tu voglia dire che i documenti sono archiviati nella libreria/PKGNAME/html, giusto? Posso collegarmi a un documento da una knitr html_vignette con [someFun] (../ html/someFun.html) –

+1

Questo codice più breve in help invece di html funziona anche per me: [someFun] (../ help/someFun) –