Permalink
Browse files

roxygenize with roxygen2 4.0

  • Loading branch information...
1 parent 682ecc7 commit ef3b35052b5be7ee652178f4ac5b29932012211c @yihui committed Mar 4, 2014
Showing with 20 additions and 31 deletions.
  1. +0 −5 DESCRIPTION
  2. +3 −5 man/add_list.Rd
  3. +2 −2 man/hello.Rd
  4. +2 −3 man/hiNorm.Rd
  5. +4 −5 man/reverse.Rd
  6. +2 −2 man/rock_fun.Rd
  7. +7 −9 man/split_filename.Rd
View
@@ -15,8 +15,3 @@ Description: This is a minimal R package which shows you how to write R
License: GPL
URL: https://github.com/yihui/rmini
BugReports: https://github.com/yihui/rmini/issues
-Collate:
- 'S3.R'
- 'C.R'
- 'roxygen.R'
- 'data.R'
View
@@ -10,12 +10,10 @@
\item{y}{an arbitrary R object}
}
\value{
- A list with \code{y} being added to \code{x} as its last
- element.
+A list with \code{y} being added to \code{x} as its last element.
}
\description{
- This is an S3 generic function for \code{+} with the
- class \code{Foo}.
+This is an S3 generic function for \code{+} with the class \code{Foo}.
}
\examples{
structure(list(1), class = "Foo") + 2
@@ -28,5 +26,5 @@ z + 5 + matrix(1:4, 2) # you can add arbitrary objects to z
methods("+") # check the methods on +
}
\author{
- Yihui Xie <\url{http://yihui.name}>
+Yihui Xie <\url{http://yihui.name}>
}
View
@@ -14,10 +14,10 @@ hello(x)
\item{x}{an arbitrary R object}
}
\value{
- The class of \code{x} is printed as a side-effect.
+The class of \code{x} is printed as a side-effect.
}
\description{
- Say hello on difference classes.
+Say hello on difference classes.
}
\examples{
hello(1)
View
@@ -4,13 +4,12 @@
\title{Some random data}
\format{A numeric vector.}
\source{
- Generated from \code{set.seed(123); rnorm(10)}
+Generated from \code{set.seed(123); rnorm(10)}
}
\description{
- A few numbers from \code{rnorm()}.
+A few numbers from \code{rnorm()}.
}
\examples{
data(hiNorm)
str(hiNorm)
}
-\keyword{datasets}
View
@@ -8,17 +8,16 @@ reverse(x)
\item{x}{a numeric vector}
}
\value{
- a numeric vector (reversed \code{x})
+a numeric vector (reversed \code{x})
}
\description{
- This function takes a numeric vector and returns a
- reversed version of this vector. The internal computation
- is via C.
+This function takes a numeric vector and returns a reversed version of this
+vector. The internal computation is via C.
}
\examples{
reverse(c(1, 9.3, 8.2, 4.33))
reverse(1:10)
}
\author{
- Yihui Xie <\url{http://yihui.name}>
+Yihui Xie <\url{http://yihui.name}>
}
View
@@ -8,10 +8,10 @@ rock_fun(n = 20)
\item{n}{length of letters}
}
\value{
- The last vector of letters.
+The last vector of letters.
}
\description{
- Nothing fancy.
+Nothing fancy.
}
\examples{
library(rmini)
View
@@ -10,27 +10,25 @@ split_filename(x, ...)
\item{...}{explanation of \code{...}}
}
\value{
- The value returned by this function.
+The value returned by this function.
}
\description{
- This is a brief description.
+This is a brief description.
}
\details{
- Anything else after the description goes to the Details
- section.
+Anything else after the description goes to the Details section.
- You can write several paragraphs.
+You can write several paragraphs.
}
\examples{
split_filename("foo.bar")
}
\author{
- Who are you?
+Who are you?
}
\references{
- \url{https://github.com/yihui/rmini}
+\url{https://github.com/yihui/rmini}
}
\seealso{
- \code{\link[tools]{file_ext}},
- \code{\link[tools]{file_path_sans_ext}}
+\code{\link[tools]{file_ext}}, \code{\link[tools]{file_path_sans_ext}}
}

0 comments on commit ef3b350

Please sign in to comment.