web-dev-qa-db-ja.com

Rのroxygen2のドキュメントにある他のパッケージへのリンク

roxygen2を使用して新しいパッケージのドキュメントを記述しようとしているときに、他のパッケージから機能するlinkのメソッドが存在するのではないかと思います。 \link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}のようなもの?

64

\link[pkg]{function}と入力する必要があります。 \link[stringi]{stri_c}

80
potockan

potockan による回答に加えて:
一部のパッケージでは、1つのヘルプページに複数の機能が記載されています。たとえば、Bioconductorパッケージのtrim関数 GenomicRangesintra-range-methodsに記載されています(これは IRangesなどの他のパッケージのヘルプページの名前でもあります) )。

roxygen2で正しいページにリンクするには、次のように使用できます。

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

または

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

テキストを正しくフォーマットします。

ヘルプページにはtrimのみが表示されますが、適切なヘルプページにリンクされます。

5
Pascal Martin