文档对象中未记录的参数

时间:2019-03-28 14:42:21

标签: r package

所以我试图在R中构建我的第一个程序包,但是当我运行不知道如何解决的check()时遇到错误。

我得到的错误是:

  

文档对象“ monthly.rainR”中未记录的参数     “数据库”

     

具有\ usage条目的函数需要具有适当的\ alias   条目,并记录所有参数。   \ usage条目必须对应于语法上有效的R代码。

我看了一下Hadley的书,并尝试了一些我在网上找到的建议...但是似乎没有一种解决方案

roxygen2文档如下所示:

git push

我的monthly.rain()函数如下:

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Simple.stats_rainR.R
\name{monthly.rainR}
\alias{monthly.rainR}
\title{Stand alone monthly rain plots:}
\usage{
monthly.rainR(database)
}
\value{
12 monthly average rainfall plots
}
\description{
Stand alone monthly rain plots:
}
\examples{
rain4 = load_rain()
monthly.rainR(rain4)
}

我是编写软件包的新手,所以我不确定这里发生了什么。任何建议都会很棒。

1 个答案:

答案 0 :(得分:1)

定义后

'@param

使用

'@return