R文档中哪些标签是强制性的?

时间:2012-05-08 09:49:25

标签: r

myfunction.Rd和整个包中记录R函数时 在mypackage-package.Rd中,哪些标签是强制性的?

“标签”是指那些看起来像\somename{}的东西。例如: \item{} \title{} \examples{}

1 个答案:

答案 0 :(得分:7)

这在写作R扩展的Section 2.1 - Rd format中有所描述。寻找“强制性”。

对于函数,必填部分是:

\name{name}
\alias{topic}
\title{title}
\description{...}
\usage{fun (arg1, arg2, ...)}
\arguments{...}

对于包裹:

\name{name}
\alias{topic}
\title{title}
\docType{package}