roxygen2

    22热度

    2回答

    我有两个方法用于与S3密切相关(在另一个包中定义)的密切相关的方法,所以我想将它们记录在同一个Rd文件中。然而,当我单独记录他们的论点,我从R CMD check约“文档对象重复的\参数项” ##' Create a ggplot of a Kaplan-Meier Survival curve(s) ##' ##' @param data A \code{survfit} object re

    34热度

    4回答

    RStudio是否支持任何自动化的roxygen模板创建? 在Emacs-ESS中,C-x C-o将为函数生成一个roxygen模板。例如,它会自动地转换成这样: foo <- function(x,y) x+y 到这一点: ##' .. content for \description{} (no empty lines) .. ##' ##' .. content for \detai

    19热度

    3回答

    我渴望了解如何将数据的例子如上面的功能书面意见,如: ##' @examples ##' ## Set working directory... ##' ## Load data into R session: ##' data <- system.file("extdata", "data.txt", package="...", sep="\t", header=TRUE, string

    15热度

    2回答

    我使用roxygen2作为记录我的R包的工具,并且我发现在roxygen2中有一个@references标签,但似乎只接受自由形式的文本。我发现了一些关于roxygen的介绍,其中有@bibliograph和@cite的标签,但是我确定roxygen2中没有这种东西吗? 我应该然后以某种方式拿出中文提供文件的引用,并将它们与适当的格式手动编写直接@references标签之后还是有这样的一些更聪明

    8热度

    1回答

    我有一个关于使用roxygen2软件包为我的R软件包创建.Rd文件的问题。 我很清楚,为了记录R函数,我可以在emacs中使用C-C C-o在函数上面生成注释,然后填充它们,然后填入roxygenize("pkg")。通过这种方式,我有用于R功能的.Rd文件。但是,我不确定如何获取.Rd文件的数据示例和程序包本身?目前,我正在使用prompt("data")来生成data.Rd和promptPac

    7热度

    1回答

    读书如this SO question on documenting a data set with Roxygen我已成功地记录一个数据集(我将其称为cells)问题后,现在出现在由data(package="mypackage")和生成的列表如果我运行命令data(cells)加载。在此之后,运行ls()时将出现cells。 但是,在许多包中,数据立即可用,无需拨打data()。此外,运行ls

    6热度

    1回答

    我在使用Roxygen的check分配函数时遇到问题。 这里有一个相当小的例子: #' Get sp feature IDs #' @aliases IDs IDs.default IDs.SpatialPolygonsDataFrame IDs<- IDs<-.SpatialPolygonsDataFrame #' @param x The object to get the IDs fro

    5热度

    1回答

    我创建了一个包并将其推送到github,使得devtools函数install_github()函数可以轻松安装。即github回购文件结构是这样的:DESCRIPTION和NAMESPACE与/R和/man文件夹一起位于最前面,它们分别为每个功能包含*.R文件和*.Rd文件。 我现在想通过添加新功能对它进行一些升级。 我在每个新.R文件中的函数的所有相关roxygen类型(#')上面的文字,但无

    10热度

    1回答

    我已经多次遇到以下问题。 说你有两个类,classA和classB在下列文件classA.R描述: #' the class classA #' #' This is a class A blabla #' \section{Slots}{\describe{\item{\code{A}}{a Character}}} #' @ name classA #' @rdname classA

    15热度

    1回答

    我正在编写一个包,但是一个持久的R CMD check警告阻止我完成包并将其发布到CRAN。我使用roxygen2作为内联文档,虽然这可能不是错误的根本原因。 如果你知道如何去除这个警告,我可以很有可能找出一种使用roxygen2的方法。 如何从包装检查中删除警告Functions/methods with usage in documentation object ... but not in