File: readRdHelp.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (37 lines) | stat: -rw-r--r-- 1,082 bytes parent folder | download | duplicates (5)
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
37
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  readRdHelp.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{readRdHelp}
\alias{readRdHelp.default}
\alias{readRdHelp}

\title{Reads one or more Rd help files in a certain format}

\description{
 Reads one or more Rd help files in a certain format.
}

\usage{
\method{readRdHelp}{default}(..., format=c("text", "html", "latex", "rd"), drop=TRUE)
}

\arguments{
  \item{...}{Arguments passed to \code{\link[utils]{help}}.}
  \item{format}{A \code{\link[base]{character}} string specifying the return type.}
  \item{drop}{If \code{\link[base:logical]{FALSE}} or more than one help entry is found, the result
    is returned as a \code{\link[base]{list}}.}
}

\value{
  Returns a \code{\link[base]{list}} of \code{\link[base]{character}} strings or a single \code{\link[base]{character}} string.
}

\author{Henrik Bengtsson}


\keyword{programming}