Как roxygen2 документировать методы S4, если generic уже существует в базе? - PullRequest
0 голосов
/ 15 апреля 2019

Я заблудился о том, как задокументировать оператор [.

Возьмите пример из этого другого вопроса: Как определить операторы подмножества для класса S4?

Как документировать setMethod("[", c("A", "integer", "missing", "ANY"), с roxygen2?

Книга Хэдли https://r -pkgs.org / man.html # man-classes описывает три места для документирования ваших методов в зависимости от обстоятельств. Кажется, мой случай здесь:

В своем собственном файле. Наиболее уместно, если метод сложный, или если вы написали метод, но не класс или универсальный.

И все же я заблудился, как это сделать. Было бы неплохо увидеть пример.

В качестве отступления: кажется, что Хэдли не слишком много использует S4, а ребята из Bioconductor (которые часто используют S4) тоже не слишком много используют roxygen2 ... По крайней мере, я не смог найти пакеты с примерами roxygen2 документация для методов, универсальные значения которых определены в других местах (например, в base).

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...