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