roxygen2

    2热度

    1回答

    我想知道如何记录函数需要第二个函数或包。是否有特定的标签可以这么做,或者我应该在功能描述中这么说? #' @title Downloads stuff from that place #' #' @details Maybe document the dependency here? #' #' @param stuff Thing to be downloaded #' @param

    5热度

    1回答

    一些R包他们的帮助/文档和链接到那些部分酒吧中(例如,ggplot2,dplyr,devtools等)已按字母顺序有权段(由下图红色箭头所示)。其他包(例如,RcmdrMisc)没有。 如何将这些元素添加到可能的R软件包的帮助中? 我用roxygen2的文档。

    0热度

    1回答

    我想导出一个名为[.myclass的S3method使用roxygen2,我看不到干净的方式来执行此操作。 我需要NAMESPACE有 S3method("[",myclass) 它 或之后我需要包不能被使用的方法,但roxygen2似乎并不想帮助我。 我可以强制其与 #' @S3method [ myclass setMethodS3("[", c(x="myclass"),

    0热度

    1回答

    我想为使用python编写的包创建一些文档。 当我在R中创建一个包时,roxygen2会为我做这件事。 是否有python/pandas等价物?

    12热度

    1回答

    Matrix软件包定义了一整套用于乘法矩阵的S4方法,这些方法由S4通用函数%*%,crossprod和tcrossprod调度。 如何导入用于我自己的包中的“%*%”方法? #' @title my function #' #' @description Does magic Matrix stuff #' @import methods #' @importFrom Matrix "%

    0热度

    1回答

    我正在编写一个包含其他几个导出函数使用的内部函数的包,但导出的函数都具有不同的参数。 这里是我的意思简化: general <- function(...) { # do something based on which function was called } one <- general two <- general 我知道这似乎不可思议,但所有被化名为general功能

    3热度

    1回答

    我可以很容易地输入参数,通过做这样具有@param多行做到这一点: #' @param var1 This is for x #' @param var2 This is for y #' @param var3 This is for Z 但你如何做一个列表的元素你正在返回。我想包括每个元素的名称和关于他们的描述。串联起来@return或@param不具有相同的行为。什么是适当的标签?

    0热度

    1回答

    我有一个抽象基类,看起来像这样: #' An Abstract Base Class Filter <- setRefClass( Class = "Filter", methods = list( train = function(x) { "Override this method to train any associated parameters f

    8热度

    1回答

    考虑下述R的函数定义,加以记录使用roxygen2错误地创建文档(版本> = 5.0) #' @title Test Bug #' @author Daniel Egan #' @param x #' @return Nothing #' @export #' @examples #' testFun(x) testFun <- function(x){ #' War

    2热度

    1回答

    我有一些数据文件需要使用我创建的包进行分发。我把文件放在inst/extdata中。如何以及在哪里使用roxygen2记录这些文件?