我跟着Vignette,发现pseudoprime-package.Rd中的许可证,作者等信息没有写入DESCRIPTION？我做错什么了吗？
有人能指出我用Roxygen记录R.oo类/方法的好例子吗？在R.oo中,类/方法是通过调用setConstructorS3()和setMethodS3()创建的,因此没有函数来记录本身.您是否只是创建标准的Roxygen函数文档,但是将它放在NULL语句之上？
我对错误感到困惑
found an S4 version of 'simulate' so it has not been imported correctly
我编写了一个R包,其中包含一个simulate()方法的定义作为S3方法.因为模拟通用已经定义,我简单地定义一个simulate.myclass(simulate.fitContinuous在我的情况).
该软件包还依赖于具有S4版本模拟的另一个软件包.加载我的包时,我得到上面的S4版本错误.我不确定是什么导致错误.
require(devtools)
install_github("pmc", "cboettig")
require(pmc)
要从头开始重现此错误:使用最少的DESCRIPTION文件创建一个新包.包括DESCRIPTION进口:ouch.创建一个NAMESPACE并添加导入(ouch)和S3method(模拟,测试).创建R目录,添加一个简单的R脚本(我已经包含了生成我刚才提到的NAMESPACE的roxygen文档,但是这个错误也可以在没有devtools/roxygen的情况下创建):
#' simulate
#'
#' a test for s3/s4 conflicts
#' @param object who cares?
#' @param nsim guess.
#' @param seed yup
#' @param ... other parameters we will just ignore
#' @return something
#' @method simulate test
#' @S3method simulate test
#' @import ouch
simulate.test <- function(object, nsim = …我正在制作一个包,我想为剧情定义一种新方法.我正在使用roxygen源代码文档.这个问题看起来非常类似于: 如何使用Roxygen从不同的包中正确记录泛型的S3方法？ 和 Roxygen2 - 如何正确记录S3方法, 但我仍然无法让它工作.
导致我麻烦的相关部分是:
#' Generic plot method
#'
#' @param x \dots
#' @param ... \dots
#' @export
plot <- function(x, ...) UseMethod("plot")
#' Default plot method
#'
#' @param x \dots
#' @param ... \dots
#' @importFrom graphics plot
#' @method plot default
#' @S3method plot default
plot.default <- function(x, ...) graphics::plot(x, ...)
#' Plotting function for ABI object
#'
#' Description.
#'
#' @param x ABI object as generated by newABI.
#' @param …可能重复:
在Roxygen2样式文档中转义"@"
如何在roxygen文档中使用@,如:
#' @param arg An argument that uses the symbol @
这会在你跑步时发出警告,roxygenize而不是把@放在.Rd文件中.
我想在记录R函数的上下文中在等式中排版矩阵.事实上,amsmath默认情况下R文档不可用,并且eqnarray不起作用,因为\deqn已经打开了相应的数学环境.
那么,专业人士如何做呢？通过tabular或一些这样的？
Roxygen的灵感来自C,C++程序员使用的Doxygen文档系统.我已经使用了Doxygen,只要你有doxygen评论,我发现很容易记录任何程序.它还为函数和类生成调用图.我认为roxygen会以同样的方式工作,但是当我搜索roxygen帮助时,我只找到记录R包的解决方案.
我检查了Hadley Wickham的在线roxygen2帮助,但是没有描述R脚本文档的任何内容.
我的脚本有时会变成500-1000行,并且有几个函数,我总是用注释记录.我想用graph-viz图生成PDF或HTML文档.Roxygen能够制作调用图和文档独立的R脚本吗？
作为一个简单,具体的例子:
#' Inverse Value Matching
#'
#' Complement of \code{%in%}. Returns the elements of \code{x} that are
#' not in \code{y}.
#' @usage x %nin% y
#' @param x a vector
#' @param y a vector
#' @export
"%nin%" <- function(x, y) {
return( !(x %in% y) )
}
但是,当我尝试构建一个包时,该函数似乎被忽略,并且没有生成文档.
在http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functions上似乎有关于二进制中缀函数的单行模糊,但我很难时间解析它,以及它对Roxygen文档意味着什么.
考虑一个XYZ由其他人编写的基础包,它有一个函数ABC,我想ABC通过以下方法扩展我的新(NOT XYZ)包中的功能.
ABC <- function(...){
##INSERT EXTRA WORK.
##CALL THE BASE METHOD
XYZ::ABC(...)
}
现在我想记录我的新函数ABC(通过Roxygen),创建一个指向父函数的链接以供参考.
\code{\link{XYZ::ABC}} 不起作用,找不到任何功能.
\link{ABC} 创建一个指向可能的Candiate Rd文件列表的链接,
如何创建超链接直到BASE功能.
我试图通过roxygen2在包中添加文档.我能够成功创建packag并且在加载时也可以使用这些功能.以下是我对如何操作的理解,我在RStudio上创建了一个空的R-Package项目,然后有一个名为"getSomething.R"的源文件.内容如下,
#' Test function to ask on stackoverflow
#'
#' \code{getSomething} Does something to get something.
#'
#' @param a param 1
#' @param b param 2
#'
#'
getSomething <- function(a,b){
return(a*b)
}
现在,我构建并加载包,理想情况下,应该在/ man文件夹中使用.Rd文件创建包,并且还要执行"？getSomething".但是没有使用该命令,也没有创建Rd文件.我在这里错过了什么吗？在我的原始项目中,我添加了一些依赖包.
以下是解密文件,
Package: testPackage
Type: Package
Title: Learn how to use roxygen2.
Version: 1.0.1
Date: 2014-11-27
Author: amj2403
Maintainer: amj2403 <emailid>
Description: Write something here
License: NA
Depends:
R (>= 3.0.0),
rjson,
futile.logger,
RCurl
还有NAMESPACE文件,
exportPattern( "^ [[:阿尔法:]] +"
我想我错过了一些重要的步骤.
我正在构建一个包含多个数据集的 R 包。我将数据集保存为“数据”文件夹中的 .RData 对象，并且每个数据集都有使用 .RData 生成的文档roxygen2。当我安装包时，加载它并尝试调用数据集，
devtools::install_github("jamesmartherus/nhldata")
library(nhldata)
data(teams)
我收到此错误：
In data("teams") : data set ‘teams’ not found
这是我的说明文件的内容：
Package: nhldata
Title: Easy Access to Basic NHL Data
Version: 0.1.0
Authors@R: person("James", "Martherus", email = "james@martherus.com",
role = c("aut", "cre"))
Description: Includes several datasets of NHL statistics including skater, goalie, and team statistics by season.
Depends: R (>= 3.5.0)
License: MIT
LazyData: true
RoxygenNote: 6.1.1
Encoding: UTF-8
这是我的文档文件的最小版本：
\docType{data}
\name{teams}
\alias{teams}
\title{NHL Team Statistics 2007-2019}
\format{A data …我正在尝试使用roxygen2为引用类对象创建文档,但是当我运行R CMD检查时,我不断收到此警告:
S4 class codoc mismatches from documentation object 'myRefClass-class':
Slots for class 'myRefClass'
Code: .xData
Inherited: .xData
Docs: field1 field2
这是与上述警告相关的ref class和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"))
以下是生成的R文档:
myRefClass-class {testPackaging} R文档myRefClass类
描述
myRefClass的描述
老虎机
field1字符槽
field2数字槽
至于我能找到的文档,codoc正在测试我的代码和文档之间的一致性.据我所知,所有的插槽名称都是一样的; 也许我错过了什么.不确定文档是否应该自动将其标记为引用类,或者我是否应该以某种方式指出？我发现R文档表明插槽".xData用于启用异常类型的继承",但我不确定为什么它适用于我在这里做的或者我应该用它做什么.
我已经尝试了一些roxygen标签的排列并且保持接近这里发现的结构似乎给了我最好的结果/来自R CMD检查的最少警告:Roxygen2 - 如何@export参考类生成器？ 我一直在网上寻找roxygen2应该如何与参考类一起使用的例子; 也许我正在寻找错误的地方 - 我运气不好.
我正在使用roxygen2 v 3.1.0/RStudio版本0.98.501/R版本3.0.3/OSX 10.9.2(注意:尝试升级到roxygen2 v 4.0并且它在引用类上完全被阻塞,以至于没有文档存在根本生成)
如果有人知道使用roxygen2和引用类的CRAN包,那么我可能会看到它是如何正确完成的,或者如果有人知道我做错了什么,那么帮助将非常感激.我是R的包装建筑的新手.
roxygenize在以下代码上失败,并显示以下错误消息.关于该主题的其他帖子表明存在错位的字符.我找不到任何错误!你能发现这个问题吗？
#' My Title. My Description
#'
#' @return A n x n \code{\link{matrix}} where n = the number of variables. Row and column names are in the same order and are equivalent to the variable names in \samp{timeSeriesData}. Each entry [i,j] in the matrix is the covariance between variable i and variable j.
#' @callGraphPrimitives
#' @note some notes here
MyFunc = function( timeseriesData , method , decayFactor )
{
}
Error in do.call(paste, c(trimmed.lines, sep = "\n")) : …