| Line 1... |
Line 1... |
| 1 |
% File src/library/tools/man/Rd2HTML.Rd
|
1 |
% File src/library/tools/man/Rd2HTML.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 2008-2016 R Core Team
|
3 |
% Copyright 2008-2018 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{Rd2HTML}
|
6 |
\name{Rd2HTML}
|
| 7 |
\alias{Rd2txt}
|
7 |
\alias{Rd2txt}
|
| 8 |
\alias{Rd2HTML}
|
8 |
\alias{Rd2HTML}
|
| 9 |
\alias{Rd2ex}
|
9 |
\alias{Rd2ex}
|
| 10 |
\alias{Rd2latex}
|
10 |
\alias{Rd2latex}
|
| 11 |
\title{ Rd Converters }
|
11 |
\title{ Rd Converters }
|
| 12 |
\description{
|
12 |
\description{
|
| 13 |
These functions take the output of the \code{\link{parse_Rd}} function
|
13 |
These functions take the output of \code{\link{parse_Rd}()}, an
|
| 14 |
and produce a help page from it. As they are mainly
|
14 |
\code{Rd} object, and produce a help page from it. As they are mainly
|
| 15 |
intended for internal use, their interfaces are subject to change.
|
15 |
intended for internal use, their interfaces are subject to change.
|
| 16 |
}
|
16 |
}
|
| 17 |
\usage{
|
17 |
\usage{
|
| 18 |
Rd2HTML(Rd, out = "", package = "", defines = .Platform$OS.type,
|
18 |
Rd2HTML(Rd, out = "", package = "", defines = .Platform$OS.type,
|
| 19 |
Links = NULL, Links2 = NULL,
|
19 |
Links = NULL, Links2 = NULL,
|
| Line 33... |
Line 33... |
| 33 |
stages = "render", outputEncoding = "UTF-8",
|
33 |
stages = "render", outputEncoding = "UTF-8",
|
| 34 |
commentDontrun = TRUE, commentDonttest = FALSE, ...)
|
34 |
commentDontrun = TRUE, commentDonttest = FALSE, ...)
|
| 35 |
}
|
35 |
}
|
| 36 |
\arguments{
|
36 |
\arguments{
|
| 37 |
\item{Rd}{ a filename or \code{Rd} object to use as input. }
|
37 |
\item{Rd}{ a filename or \code{Rd} object to use as input. }
|
| 38 |
\item{out}{ a filename or connection object to which to write the output. }
|
38 |
\item{out}{a filename or connection object to which to write the
|
| - |
|
39 |
output. The default \code{out = ""} is equivalent to
|
| - |
|
40 |
\code{out = \link{stdout}()}.}
|
| 39 |
\item{package}{ the package to list in the output. }
|
41 |
\item{package}{ the package to list in the output. }
|
| 40 |
\item{defines}{ string(s) to use in \verb{#ifdef} tests. }
|
42 |
\item{defines}{ string(s) to use in \verb{#ifdef} tests. }
|
| 41 |
\item{stages}{ at which stage (\code{"build"}, \code{"install"}, or
|
43 |
\item{stages}{ at which stage (\code{"build"}, \code{"install"}, or
|
| 42 |
\code{"render"}) should \verb{\Sexpr} macros be executed? See the
|
44 |
\code{"render"}) should \verb{\Sexpr} macros be executed? See the
|
| 43 |
notes below.}
|
45 |
notes below.}
|
| Line 98... |
Line 100... |
| 98 |
usually double-width, which looks wrong with English text.)
|
100 |
usually double-width, which looks wrong with English text.)
|
| 99 |
#endif
|
101 |
#endif
|
| 100 |
|
102 |
|
| 101 |
Various aspects of formatting by \code{Rd2txt} are controlled by the
|
103 |
Various aspects of formatting by \code{Rd2txt} are controlled by the
|
| 102 |
\code{options} argument, documented with the \code{\link{Rd2txt_options}}
|
104 |
\code{options} argument, documented with the \code{\link{Rd2txt_options}}
|
| 103 |
function. Changes made using \code{options} are temporary, those
|
105 |
function. Changes made using \code{options} are temporary, those
|
| 104 |
made with \code{\link{Rd2txt_options}} are persistent.
|
106 |
made with \code{\link{Rd2txt_options}} are persistent.
|
| 105 |
|
107 |
|
| 106 |
When \code{fragment = TRUE}, the \code{Rd} file will be rendered
|
108 |
When \code{fragment = TRUE}, the \code{Rd} file will be rendered
|
| 107 |
with no processing of \verb{\Sexpr} elements or conditional defines
|
109 |
with no processing of \verb{\Sexpr} elements or conditional defines
|
| 108 |
using \verb{#ifdef} or \verb{#ifndef}. Normally a fragment represents
|
110 |
using \verb{#ifdef} or \verb{#ifndef}. Normally a fragment represents
|
The R Project SVN
R