Каковы предпочтительные средства для определения метода S3 в пакете R без введения зависимости?

Question

У меня есть пакет R (не в настоящее время в CRAN), который определяет пару методов S3 обобщенных c функций из других пакетов (в частности, knitr::knit_print и huxtable::as_huxtable). Однако они не являются ключевой частью моего пакета, поэтому я бы предпочел не создавать зависимости от этих пакетов, когда пользователь устанавливает мой пакет. Вплоть до R 4.0.0 я экспортировал методы S3 без импорта шаблонов. Используя roxygen2, моя директива @export была преобразована в директиву export() в NAMESPACE, а не S3method(). Это работало нормально в версиях R <4.0.0, потому что R сначала ищет в глобальной среде соответствующий метод <code>generic_function.class, а не полагается на правильную регистрацию метода S3. Однако, согласно этому блогу на developer.r-project.org , R больше не ищет незарегистрированные методы S3.

Как лучше всего обойти это? Сейчас я добавил директивы @importFrom в свои блоки roxygen2 и добавил оба пакета в раздел импорта ОПИСАНИЯ. Однако, как я понимаю, это будет означать, что любой пользователь, устанавливающий мой пакет, должен будет также установить knitr и huxtable независимо от того, хотят они этого или нет.

Answer 1

К счастью, для R> = 3.6.0 вам даже не нужен ответ от caldwellst . Из записи в блоге, на которую вы ссылались выше:

Начиная с R 3.6.0, директивы S3method () в NAMESPACE также могут использоваться для выполнения отложенной регистрации метода S3. С помощью функции S3method (PKG :: GEN, CLS, FUN) FUN регистрируется как метод S3 для класса CLS и генерируется c GEN из пакета PKG, только когда загружено пространство имен PKG. Это может быть использовано для ситуаций, когда метод не требуется «немедленно», и необходимость предварительно загружать пространство имен pkg (и все его сильные зависимости) для выполнения немедленной регистрации считается слишком «дорогостоящим».

Кроме того, это также обсуждается в документации для другого предложения vctrs::s3_register():

#' For R 3.5.0 and later, `s3_register()` is also useful when demonstrating
#' class creation in a vignette, since method lookup no longer always involves
#' the lexical scope. For R 3.6.0 and later, you can achieve a similar effect
#' by using "delayed method registration", i.e. placing the following in your
#' `NAMESPACE` file:
#'
#' ```
#' if (getRversion() >= "3.6.0") {
#'   S3method(package::generic, class)
#' }

Итак, вам просто нужно не использовать @importFrom и вместо @export используйте @exportS3Method package::generic (см. https://github.com/r-lib/roxygen2/issues/796 и https://github.com/r-lib/roxygen2/commit/843432ddc05bc2dabc9b5b22c1ae7de507a00508)

Иллюстрация

Итак, чтобы проиллюстрировать это, мы можем сделать две очень простых упаковки, foo и bar. Пакет foo просто имеет обобщенную функцию c foo() и метод по умолчанию:

library(devtools)
create_package("foo")

#' foo generic
#'
#' @param x An object
#' @param ... Arguments passed to or from other methods
#' @export
foo <- function(x, ...) {
    UseMethod("foo", x)
}
#' foo default method
#'
#' @param x An object
#' @param ... Arguments passed to or from other methods
#' @export
foo.default <- function(x, ...) {
    print("Called default method for foo.")
}

После document() и install() ing мы создаем bar:

create_package("bar")

, который создает bar метод для foo():

#' bar method for foo
#'
#' @param x A bar object
#' @param ... Arguments passed to or from other methods
#'
#' @exportS3Method foo::foo
foo.bar <- function(x, ...) {
    print("Called bar method for foo.")
}

Важно, что мы должны загрузить пакет foo перед запуском document(), или @exportS3Method не будет работать. То есть

library(foo)
document()

Но, если мы сделаем это, мы получим в NAMESPACE для bar следующее:

# Generated by roxygen2: do not edit by hand

S3method(foo::foo,bar)

Мы должны вручную добавить foo на «Предлагает» в DESCRIPTION.

Тогда, если мы удалим foo, мы все равно сможем установить bar:

> remove.packages("foo")
Removing package from ‘/home/duckmayr/R/x86_64-pc-linux-gnu-library/4.0’
(as ‘lib’ is unspecified)
> install("bar")
✓  checking for file ‘/home/jb/bar/DESCRIPTION’ ...
─  preparing ‘bar’:
✓  checking DESCRIPTION meta-information ...
─  checking for LF line-endings in source and make files and shell scripts
─  checking for empty or unneeded directories
─  building ‘bar_0.0.0.9000.tar.gz’

Running /opt/R/4.0.0/lib/R/bin/R CMD INSTALL \
  /tmp/Rtmp5Xgwqf/bar_0.0.0.9000.tar.gz --install-tests 
* installing to library ‘/home/jb/R/x86_64-pc-linux-gnu-library/4.0’
* installing *source* package ‘bar’ ...
** using staged installation
** R
** byte-compile and prepare package for lazy loading
** help
*** installing help indices
** building package indices
** testing if installed package can be loaded from temporary location
** testing if installed package can be loaded from final location
** testing if installed package keeps a record of temporary installation path
* DONE (bar)

Answer 2

Пакет vctrs предоставляет функцию с именем s3_register, которая динамически регистрирует методы для использования в функции .onLoad. Вы можете прочитать больше о его использовании здесь , для себя вы бы хотели:

.onLoad <- function(...) {
  if (requireNamespace("knitr", quietly = TRUE)) {
    vctrs::s3_register("knitr::knit_print", "class_name")
  }
  if (requireNamespace("huxtable", quietly = TRUE)) {
    vctrs::s3_register("huxtable::as_huxtable", "class_name")
  }
}

Документация также хорошая, поэтому вам не нужно импортировать vctrs:

Чтобы не зависеть от vctrs для этой одной функции, пожалуйста, не стесняйтесь копировать и вставлять источник функции в ваш собственный пакет.