2016-01-22 10 views
13

Gibt es eine Möglichkeit, Links zwischen Paketvignetten in R einzuschließen? Ich weiß, ich kann zwischen Abschnitt verknüpfen, zum BeispielVerknüpfen von R-Paketvignetten

# Section 1 {#section1} 
My first section 

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

Aber ist es eine Möglichkeit, einen anklickbaren Link zu bekommen, die die HTML doucment einer anderen Vignette starten wird? Oder ist es einfacher, den Code zu geben, um ihn zu starten?

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

Hinweis Ich habe alle meine Vignetten mit Rmarkdown und knitr erzeugt.

Antwort

15

Ja, das ist einfach. Vignetten werden alle im selben Verzeichnis gespeichert, daher verweisen Sie einfach auf den entsprechenden Dateinamen. Das drat-Paket vignettes hat mehrere Beispiele dafür. Hier ist ein Link von einer Vignette auf der anderen Seite:

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. 

Dies funktioniert auf CRAN und auf einem Computer des Benutzers.

Sie sollten auch in der Lage sein, von Vignetten zur Dokumentation und umgekehrt auf dem Computer eines Benutzers zu verlinken, da Vignetten in library/PKGNAME/doc/ gespeichert sind und die Dokumentation gespeichert wird in: .

+0

Ja, funktioniert. Fantastisch. Vielen Dank - mir fehlte das '.html', weshalb ich es selbst nicht zur Arbeit bringen konnte. – nathaneastwood

+1

Ich denke du meinst docs sind in der Bibliothek/PKGNAME/html gespeichert, oder? Ich kann von einer knitr html_vignette mit [someFun] (../ html/someFun.html) zu einem Dokument verlinken. –

+1

Dieser kürzere Code in help anstelle von html funktioniert auch für mich: [someFun] (../ help/someFun) –