Permalink
Browse files

roxygenize

  • Loading branch information...
1 parent 39ce9c2 commit 93bcebb3bb6d21bd8c76b80055e4128e37d5e690 @yihui committed Oct 9, 2012
Showing with 8 additions and 2 deletions.
  1. +6 −1 man/knit.Rd
  2. +2 −1 man/spin.Rd
View
@@ -5,7 +5,7 @@
\usage{
knit(input, output = NULL, tangle = FALSE, text = NULL, envir = parent.frame())
-purl(...)
+purl(..., documentation = FALSE)
}
\arguments{
\item{input}{path of the input file}
@@ -24,6 +24,11 @@ purl(...)
to be evaluated (can use \code{\link{new.env}()} to
guarantee an empty new environment)}
+ \item{documentation}{logical: whether to write
+ documentation lines into the tangled file as roxygen
+ comments (\code{FALSE} means only computer code is
+ written out)}
+
\item{...}{arguments passed to \code{\link{knit}}}
}
\value{
View
@@ -36,7 +36,8 @@ spin(hair, knit = TRUE, report = TRUE, format = c("Rmd", "Rnw", "Rhtml", "Rtex",
converts it to a literate programming document. By
default normal text (documentation) should be written
after the roxygen comment (\code{#'}) and code chunk
- options are written after \code{#+} or \code{#-}.
+ options are written after \code{#+} or \code{#-} or
+ \code{# @knitr}.
}
\details{
Obviously the goat's hair is the original R script, and

0 comments on commit 93bcebb

Please sign in to comment.