Ссылки на другие пакеты в документации в roxygen2 в R

Мне интересно, существует ли метод link для работы из другого пакета, когда я пытаюсь написать документацию для нового пакета, используя roxygen2. Что-то вроде \link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}?


r documentation roxygen2
person Marcin Kosiński    schedule 25.08.2014    source источник
comment
Попробуйте \code{\link[MASS]{stats}} с здесь (прокрутите вниз).   -  person joran    schedule 25.08.2014
comment
Спасибо. Mb вы знаете, где я могу найти полный список параметров документации roxygen2, например, что означает @param или @family и так далее? Есть много, что я не мог найти информацию о них нигде. Например:   -  person Marcin Kosiński    schedule 25.08.2014

Ответы (4)


arrow_upward
112
arrow_downward

Вы должны ввести \link[pkg]{function} например. \link[stringi]{stri_c}

person potockan    schedule 25.08.2014
comment
такой короткий ответ, но такой ценный :) - person Marcin Kosiński; 05.06.2018
comment
обратите внимание на альтернативный рабочий процесс документации главы в книге Хэдли. Для того, чтобы увидеть ссылки, нужно пересобрать пакет, а не только передокументировать. - person tjebo; 28.03.2020

arrow_upward
27
arrow_downward

Roxygen2 теперь также поддерживает документацию, написанную в уценке.

Синтаксис уценки для ссылки — [foo::bar()], которая преобразуется в \code{\link[foo:bar]{foo::bar()}} в сгенерированном файле .Rd. (См. виньетку Roxygen2.)

Обратите внимание, что вам может потребоваться специально включить поддержку Markdown, написав Roxygen: list(markdown = TRUE) в вашем файле DESCRIPTION, или поместив комментарий #' @md, если вы хотите включить уценку только для определенной справочной страницы. Это также объясняется в самом верху связанной виньетки. (Спасибо @Tjebo за комментарий)

Обратите внимание, что в версии уценки есть два двоеточия, тогда как в версии Rd есть только одно двоеточие.

person cbeleites unhappy with SX    schedule 14.12.2019
comment
Ух ты, потрясающе!! Спасибо - person Marcin Kosiński; 15.12.2019
comment
Обратите внимание, что вам может потребоваться специально включить поддержку Markdown (см. виньетку Roxygen2 - person tjebo; 28.03.2020

arrow_upward
12
arrow_downward

В дополнение к ответу potockan:
Некоторые пакеты документируют несколько функций на одной странице справки. Например, функция trim из пакета Bioconductor GenomicRanges задокументирована в intra-range-methods ( это также название страницы справки из других пакетов, таких как IRanges. ).

Чтобы сделать ссылку на нужную страницу с помощью roxygen2, вы можете использовать:

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

or 

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

правильно оформить текст.

На странице справки будет отображаться только trim, но будет ссылка на нужную страницу справки.

person Pascal Martin    schedule 25.10.2018

arrow_upward
6
arrow_downward

Из книги пакеты R:

  • \code{\link{function}} - функция в этом пакете.
  • \code{\link[MASS]{abbey}} - функция в другом пакете.
  • \link[=dest]{name} - ссылка на место назначения, но показывать имя.
  • \code{\link[MASS:abbey]{name}} - ссылка на функцию в другом пакете, но с указанием имени.
  • \linkS4class{abc} - ссылка на класс S4.

Примечание. В четвертом варианте есть только одно двоеточие, а не два, как один используется при ссылке на функции из других пакетов в коде.

person GoGonzo    schedule 17.03.2020