File: write2.internal.Rd

package info (click to toggle)
r-cran-arsenal 3.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,788 kB
  • sloc: sh: 18; makefile: 5
file content (28 lines) | stat: -rw-r--r-- 1,018 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/write2.internal.R
\name{write2.internal}
\alias{write2.internal}
\alias{verbatim}
\alias{code.chunk}
\title{Helper functions for \code{write2}}
\usage{
verbatim(...)

code.chunk(..., chunk.opts = "r")
}
\arguments{
\item{...}{For \code{verbatim}, objects to print out monospaced (as if in the terminal). For \code{code.chunk},
either expressions or single character strings to paste into the code chunk.}

\item{chunk.opts}{A single character string giving the code chunk options. Make sure to specify the engine!}
}
\description{
Helper functions for \code{\link{write2}}.
}
\details{
The \code{"verbatim"} class is to tell \code{\link{write2}} to print the object inside
  a section surrounded by three back ticks. The results will look like it would in the terminal (monospaced).

\code{code.chunk()} is to write explicit code chunks in the \code{.Rmd} file; it captures the call and writes it to the
  file, to execute upon knitting.
}