Last active
January 15, 2016 04:20
-
-
Save Dixhom/1f4ba5d5b166d2f4a816 to your computer and use it in GitHub Desktop.
RstudioでRパッケージを作ってみる 2 ~マニュアル作成~ ref: http://qiita.com/Dixhom/items/3cf24c5e80392a99e72e
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
\name{hello} | |
\alias{HelloWorld} | |
%- Also NEED an '\alias' for EACH other topic documented here. | |
\title{ | |
%% ~~function to do ... ~~ | |
hello | |
} | |
\description{ | |
%% ~~ A concise (1-5 lines) description of what the function does. ~~ | |
It prints "Hello world!" ten times. That's all. | |
} | |
\usage{ | |
hello() | |
} | |
%- maybe also 'usage' for other objects documented here. | |
\arguments{ | |
\item{No argument}{ | |
%% ~~Describe \code{x} here~~ | |
No argument for this function. | |
} | |
} | |
\details{ | |
%% ~~ If necessary, more details than the description above ~~ | |
Again, it prints "Hello world!" ten times. That's all. | |
} | |
\value{ | |
%% ~Describe the value returned | |
%% If it is a LIST, use | |
%% \item{comp1 }{Description of 'comp1'} | |
%% \item{comp2 }{Description of 'comp2'} | |
%% ... | |
} | |
\references{ | |
%% ~put references to the literature/web site here ~ | |
[1] www.dummyurl.com | |
} | |
\author{ | |
%% ~~who you are~~ | |
John Doe | |
} | |
\note{ | |
%% ~~further notes~~ | |
This is the note. | |
} | |
%% ~Make other sections like Warning with \section{Warning }{....} ~ | |
\seealso{ | |
%% ~~objects to See Also as \code{\link{help}}, ~~~ | |
} | |
\examples{ | |
# prints "Hello world" ten times | |
hello() | |
% Add one or more standard keywords, see file 'KEYWORDS' in the | |
% R documentation directory. | |
\keyword{ keyword1 } | |
\keyword{ keyword2 } | |
\keyword{ keyword3 } | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment