как мне документировать ссылочный класс R?

как мне документировать использование функций-членов ссылочного класса?

, если я напишу файл Rd с блоком \ usage , как мне избежать WARNING

Functions/methods with usage in documentation object 'XmlDoc' but not in code:
  $ new

, я бы ожидал \ usage ], чтобы я мог писать такие вещи, как:

obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)

, а затем я бы задокументировал параметры в блоке \ arguments .

Если я это сделаю, R CMD check пожалуется с

Assignments in \usage in documentation object 'ClassName':

и не распознает методы как объекты кода, которые мне нужны в документе.

на данный момент я пишу файлы Rd без блока \ usage и пишу вышеуказанное код в блоке \ examples , но тогда мне некуда документировать аргументы, и таким образом проверка действительно имеет очень мало для проверки. Поскольку меня это не устраивает, я сейчас спрашиваю сообщество о текущей распространенной практике.

6
задан mariotomo 20 July 2011 в 08:27
поделиться