2012-05-08 38 views
3

當記錄myfunction.Rd中的R函數和mypackage-package.Rd中的整個包 時,哪些標記是強制​​性的?R文檔中哪些標籤是強制性的?

通過「標籤」,我的意思是那些看起來像\somename{}的東西。例如: \item{} \title{} \examples{}

回答

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}