为引用类压倒一切的基类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文件，但在man文件中为第二类docstring为重写的类没有通过 - 我得到基类的文档字符串。我做错了什么或者这是roxygen2的错误？

还有没有更好的方法来做到这一点？我希望能够使用多行文档。

Answer 1

已经通过roxygen github回购的问题进行了搜索。研究发现，有已经属于这个活动问题：

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

总结：在roxygen的支持和文档引用类不是很大的V5.0的。建议的方法仍然使用文档字符串，并且不可能覆盖父母的文档。