Warning: file_get_contents(/data/phpspider/zhask/data//catemap/4/r/72.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
使用roxygen2 R CMD记录参考类检查codoc不匹配警告_R_Documentation_Roxygen2_Reference Class_Roxygen - Fatal编程技术网

使用roxygen2 R CMD记录参考类检查codoc不匹配警告

使用roxygen2 R CMD记录参考类检查codoc不匹配警告,r,documentation,roxygen2,reference-class,roxygen,R,Documentation,Roxygen2,Reference Class,Roxygen,我试图使用roxygen2为引用类对象制作文档,但在运行R CMD check时,我一直收到以下警告: S4 class codoc mismatches from documentation object 'myRefClass-class': Slots for class 'myRefClass' Code: .xData Inherited: .xData Docs: field1 field2 这是与上述警告相关的ref类和roxygen2区块: #' @titl

我试图使用roxygen2为引用类对象制作文档,但在运行R CMD check时,我一直收到以下警告:

  S4 class codoc mismatches from documentation object 'myRefClass-class':
  Slots for class 'myRefClass'
  Code: .xData
  Inherited: .xData
  Docs: field1 field2
这是与上述警告相关的ref类和roxygen2区块:

#' @title myRefClass class
#' @description Description of myRefClass
#' @import methods
#' @exportClass myRefClass
#' @slot field1 A character slot
#' @slot field2 A numeric slot
myRefClass<-setRefClass(Class="myRefClass", 
                        fields=list(field1="character", 
                        field2="numeric"))
#@title myRefClass类
#“@description myRefClass的说明
#“@导入方法
#“@exportClass myRefClass
#“@slot field1字符槽
#“@slot field2一个数字插槽

myRefClass我通常使用
@节字段
,因此在这种情况下:

#' @title myRefClass class
#' @description Description of myRefClass
#' @import methods
#' @exportClass myRefClass
#' @section Fields:
#' \describe{
#' \item{\code{field1}:}{Object of class \code{"character"}, field1 description here}
#' \item{\code{field2}:}{Object of class \code{"numeric"}, field2 description here}
#' }

myRefClass<-setRefClass(Class="myRefClass", 
                        fields=list(field1="character", 
                        field2="numeric"))

我在记录引用类时不使用
@slots
。我只使用
@节字段:
。例如,我在记录RC方面看到了进展,但我没有足够的勇气改变目前的运作;)令人惊叹的!成功了。谢谢你,哈里森。如果你想将其作为答案提交,我想将其标记为可接受的解决方案。或者只是
@fields
,roxygen2 4.0.1中新增的@hadley更新,我发现我不得不使用
@field
而不是
@fields
你?哦,是的,很抱歉输入错误。@hadley 4.0.1对于引用类来说似乎很棒。我只需要将我的包移动到
@field
,然后就可以使用docstrings来表示方法了。那么,您如何记录该类的方法呢?
#' A Reference Class to represent test1.
#' @name test1
#' @import methods
#' @exportClass myRefClass
#' @field field1 A character vector
#' @field field2 A numeric vector

myRefClass<-setRefClass(Class="myRefClass", 
                        fields=list(field1="character", 
                                    field2="numeric"))
A Reference Class to represent test1.
Description

A Reference Class to represent test1.
Fields

field1

    A character vector
field2

    A numeric vector