Я прочитал PDF-файл Roxygen2, а также этот сайт , и я не понимаю разницы между @method @ S3method @export и того, как вы их используете для правильно документируйте методы S3. Для обсуждения я разработал следующий пример:
1. Как мне это должным образом задокументировать?
2. Как мне эмулировать документацию по? Print и другим универсальным функциям, которые показывают варианты использования для всех имплементаций, зависящих от класса (т.е. способ? Print показывает использование для 'factor', 'table', 'function')
3. Со страницы вики: «Все экспортируемые методы нуждаются в теге @ S3method. Он имеет тот же формат, что и @method. Это экспортирует метод, а не функцию - т.е. generic (myobject) будет работать, но generic.mymethod (myobject) не будет . "
Я не могу это интерпретировать. Кажется, это говорит о том, что вызовы функций / методов не будут работать должным образом, если теги указаны неправильно? Что конкретно сломается?
MyHappyFunction = function( x , ... )
{
UseMethod( "MyHappyFunction" )
}
MyHappyFunction.lm = function( x , ... )
{
# do some magic
}