标签: roxygen2

Roxygen注释涉及为行添加前缀#'.在编写和测试函数示例时,能够打开和关闭注释很好.我可以将代码复制并粘贴到vim并删除或添加这些注释,但这不是很优雅.

• 有没有简单的方法来在Rstudio中切换roxygen评论？
• 或者,是否有另一种方法可以有效地运行由roxygen注释字符注释掉的示例R代码？

更新:横向思考,我认为使用@example examples/foo.r是另一种避免必须对实际示例代码使用Roxygen注释的方法(即,通过从文件中获取示例,即examples/foo.r).

所以,我想在函数的roxygen2注释中引用我的一个包装晕影,但我很难理解如何做到这一点.

更一般地说,我们如何在里面引用文件/inst/doc？例如,我想/inst/doc/mypdf.pdf在roxygen2评论中引用myFunc.那会是什么样的？它甚至可能吗？

我有2个文件,Rfile.R和Cppfile.cpp.

Cppfile.cpp中的内容:

#include <Rcpp.h>
using namespace Rcpp;
// [[Rcpp::export]]
int CPPF(int k){return ++k;}

Rfile.R中的内容:

RF<-function(k){return(CPPF(k))}

我想基于2个文件构建一个R包.我使用最新版本的Rstudio和Roxygen2.

我尝试了3种方法来构建包含或不包含Roxygen2的包,并且有不同的结果:

1. New Project-> New Directory-> R package-> Type:Package w/Rcpp,将Rfile.R和Cppfile.cpp都添加为源文件.构建和重新加载,一切正常.这些功能可以正常工作.

2. New Project-> New Directory-> R package-> Type:Package w/Rcpp,将Rfile.R和Cppfile.cpp都添加为源文件.选择"使用Roxygen生成文档",检查其所有选项.构建和重新加载,功能不起作用.输入"RF"给出RF的内容,输入"CPPF"弹出"未找到对象".

3. New Project-> New Directory-> R package-> Type:Package w/Rcpp,只添加Cppfile.cpp作为源文件.选择"使用Roxygen生成文档",检查其所有选项.Build&Reload,功能正常.然后将Rfile.R直接复制到项目文件夹 - > R文件夹中.Build&Reload,一切都很好,功能很好.

我使用Roxygen错了还是Roxygen有虫子？我需要它来记录.我可以坚持第三种方式,这需要花费很多精力才能找到,但有线.

谢谢!

解决问题的一种方法:选择"使用Roxygen生成文档"时,请勿选中"NAMESPACE文件"选项.

考虑以下R函数定义,使用roxygen2进行记录(版本> = 5.0)

#' @title Test Bug
#' @author Daniel Egan
#' @param x  
#' @return Nothing
#' @export
#' @examples
#' testFun(x)


testFun <- function(x){

  #' Warning1'
  return(TRUE)
}

当使用devtools :: document()来记录它时,它会产生以下错误:

警告消息:
1:@examples [TestFun.R#8]:大括号或引号不匹配

请注意,"示例"部分中绝对没有不匹配的大括号或引号.是什么造成的？我该如何解决？

我可以通过输入参数轻松地做到这一点,@param通过这样做多行:

#' @param var1 This is for x
#' @param var2 This is for y
#' @param var3 This is for Z

但是,如何为要返回的列表元素执行此操作.我想要包含每个元素的名称和关于它们的描述.链接在一起@return或@param没有相同的行为.什么是合适的标签？

#' @return A list with the following elements:
#' @something element1 Contains x
#' @something element2 Contains y
#' @something element3 Contains z

该软件包samr具有我正在寻找的确切降价格式:

我已经在我的笔记本电脑上设置并定期更新我的R包到GitHub,跟随Hadley关于Devtools,Roxygen2等的大量文档.昨天我决定使用我的主PC,现在我正在寻求将更改推送到GitHub.输入后我收到以下错误document():

Error: 'Adult_Females' is not an exported object from 'namespace:gbm.auto'

Adult_Females是/ Data中第一个数据文件的名称.根据这个(向下滚动到'数据')

"生活在数据中的文件/不使用通常的命名空间机制,不需要导出."

那么......一个人要做什么？我没有以任何方式编辑Adult_Females,我编辑的R脚本没有引用它.我怀疑是这个错误会弹出所有的数据文件,而这恰好是第一个,但这是猜想.

提前致谢.install_github("SimonDedman/gbm.auto")如果你想看看.

我正在重构一个导入许多其他包的完整命名空间的包。我相信这些依赖项中的许多用于单个函数调用用途，使用 importFrom 可以更好地处理它们，或者是不再使用的孤立依赖项。

包中有足够的代码，手动检查每一行寻找不熟悉的函数调用会很乏味。

如何确定在包中使用导入的命名空间中的对象的位置和次数？请注意，这个包不包括单元测试。

这是一个可重现的示例：

DESCRIPTION 文件：

Package: my_package
Title: title
Version: 0.0.1
Authors@R: person(
  given = "A",
  family = "Person",
  role = c("aut", "cre"),
  email = "person@company.com"
)
Description: Something
License: Some license
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
Imports: 
  dplyr,
  purrr,
  stringr

NAMESPACE 文件：

import(dplyr)
import(purrr)
import(stringr)

my_package.R 文件：

#' my_package
#' @docType package
#' @name my_package
NULL
#' @import dplyr
#' @import purrr
#' @import stringr
NULL

functions.R 文件

#' add 1 to "banana" column and …

我有一个关于使用该roxygen2包为我的R包创建.Rd文件的问题.

我很清楚,为了记录R函数,我可以在emacs中使用Cc Co在函数上面生成注释,然后填写它们,然后填写roxygenize("pkg").这样,我有R函数的.Rd文件.但是,我不知道如何获得数据示例和包本身的.Rd文件？目前,我正在使用prompt("data")生成data.Rd并promptPackage("pkg")生成pkg-package.Rd.我必须将这些文件放入该man文件夹,然后单独编辑它们.如何以类似的方式记录数据和包,如使用roxygen2？记录R函数？

非常感谢你!

每当我Build & Reload从RStudio的Build窗格运行时,我都会收到消息

==> Rcmd.exe INSTALL --no-multiarch rwiots    
Error: contains a blank line

事实上,当我看时,我的DESCRIPTION文件在Suggests字段中包含一个空行.如果我删除它,它会在我尝试时再次创建Build & Reload.

我Generate documentation with Roxygen勾选了选项,并在Configure...对话框中勾选了所有框.

我非常喜欢使用roxygen2记录我的函数并让RStudio构建我的NAMESPACE文件和我的DESCRIPTION文件的部分工作流程.那么我怎样才能解决这个非常奇怪的小问题呢？

非常感谢Rob Levy

我看到我最近的包构建不再创建手册,即使我没有在构建设置中添加"--no-manual".之前我没有遇到过这个问题 - 我最近更新了devtools和roxygen2.

我错过了什么吗？

以下是我设置项目选项的方法: