web-dev-qa-db-fra.com

Lien vers d'autres packages dans la documentation de roxygen2 dans R

Je me demande s'il existe une méthode pour link pour fonctionner à partir d'un autre package lorsque j'essaie d'écrire une documentation pour un nouveau package en utilisant roxygen2. Quelque chose comme \link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}?

64
Marcin Kosiński

Vous devez taper \link[pkg]{function} par exemple. \link[stringi]{stri_c}

80
potockan

En plus de la réponse de potockan :
Certains packages documentent plusieurs fonctions dans une seule page d'aide. Par exemple, la fonction trim du package Bioconductor GenomicRanges est documentée dans intra-range-methods (qui est également le nom d'une page d'aide d'autres packages tels que IRanges ).

Pour créer un lien vers la page de droite avec roxygen2 vous pouvez utiliser:

\link[GenomicRanges:intra-range-methods]{trim} 

ou

\code{\link[GenomicRanges:intra-range-methods]{trim}}  

pour formater correctement le texte.

La page d'aide n'affichera que trim mais sera liée à la bonne page d'aide.

5
Pascal Martin