Строки документации roxygen2 для ссылочных классов, переопределяющих базовый класс

У меня есть абстрактный базовый класс, который выглядит так:

#' An Abstract Base Class 
Filter <- setRefClass(
  Class = "Filter",
  methods = list(
    train = function(x) {
      "Override this method to train any associated parameters for the filter on the supplied data"
  print("no learning to be done")
})
)

и следующий класс, который расширяет этот класс:

#' Filter class that leverages the prcomp R method. 
PcaFilter <- setRefClass(
  "PcaFilter",
  contains="Filter",
  fields=list(
    d="numeric",
    model="ANY"
    ),
  methods=list(
    train=function(x) {
      "train PCA model, store result to model attribute of obj"
      model <<- prcomp(x)
    })
)

После того, как я побегу

roxygen2::roxygenize()

Затем я получаю два справочных файла, но в справочном файле для второго класса строка документации для переопределенного класса не проходит — я получаю строку документации для базового класса. Я что-то не так делаю или это ошибка roxygen2?

Также есть ли лучший способ сделать это? Я хотел бы иметь возможность использовать многострочные строки документации.


person John Greenall    schedule 05.02.2016    source источник


Ответы (1)


Выполнив поиск по проблемам в репозитории roxygen github. Обнаружено, что уже есть активная проблема, относящаяся к этому:

https://github.com/klutometis/roxygen/issues/433

Подводя итог: поддержка и документация для ссылочных классов в roxygen не очень хороши с версии 5.0. Предлагаемый метод по-прежнему заключается в использовании строк документации, и невозможно переопределить строки документации родителей.

person John Greenall    schedule 08.02.2016