roxygen2 строки документации для справки Классов наиважнейших базового класса

Question

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

#' 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() 

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

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

Answer 1

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

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

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