File: brew.Rd

package info (click to toggle)
r-cran-pander 0.6.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,804 kB
  • sloc: javascript: 301; cpp: 145; lisp: 94; makefile: 21
file content (36 lines) | stat: -rw-r--r-- 1,390 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/brew.R
\name{brew}
\alias{brew}
\title{Patched brew}
\usage{
brew(text = NULL, envir = parent.frame())
}
\arguments{
\item{text}{character vector}

\item{envir}{environment}
}
\value{
\code{brew}ed document to \code{stdout} and raw results while evaluating the \code{text} in a structured list.
}
\description{
This is a forked/patched version of `brew` package made by Jeffrey Horner (c) 2007. See: \code{References} about the original version.
}
\details{
This custom function can do more and also less compared to the original \code{brew} package. First of all the internal caching mechanism (and other, from \code{pander} package POV needless features) of `brew` is removed for some extra profits:
\itemize{
     \item multiple R expressions can be passed between \code{<\%= ... \%>} tags,
     \item the text of the file and also the evaluated R objects are (invisibly) returned in a structured list, which can be really useful while post-processing the results of `brew`.
}
}
\note{
This function should be never called directly (use \code{brew::brew} instead) as being a helper function of \code{Pandoc.brew}.
}
\references{
Jeffrey Horner (2011). _brew: Templating Framework for Report Generation._ \url{https://cran.r-project.org/package=brew}
}
\seealso{
\code{\link{Pandoc.brew}}
}
\keyword{internal}