2013-11-16 3 views
3

Рассмотрим базовый пакет XYZ, написанный кем-то еще, который имеет функцию ABC, я хочу расширить функциональность ABC в новом пакете (NOT XYZ) следующим способом.R Roxygen ссылка на родительскую функцию

ABC <- function(...){ 
    ##INSERT EXTRA WORK. 

    ##CALL THE BASE METHOD 
    XYZ::ABC(...) 
} 

Теперь я хочу, чтобы документировать свою новую функцию ABC (через Roxygen), создавая ссылку на родительскую функцию для справочных целей.

\code{\link{XYZ::ABC}} не работает, функция не может быть найдена.

\link{ABC} создает ссылку на список возможных candiate Rd файлов,

Как создать гиперссылку НАПРЯМУЮ к БАЗЫ функции.

+0

'@importsFrom XYZ ABC', нет? – Noah

+0

не работает .... –

+3

'\ code {\ link [XYZ] {ABC}}' – GSee

ответ

7

\code{\link[XYZ]{ABC}}

Это кратко описан в Cross-references разделе Написание R Extensions:

Есть две других форм дополнительного аргумента, определенные как \ ссылка [PKG] {Foo} и \ ссылка [ pkg: bar] {foo}, чтобы ссылаться на пакет pkg, на файлы foo.html и bar.html соответственно.

 Смежные вопросы

  • Нет связанных вопросов^_^