File: parse_text.Rd

package info (click to toggle)
r-cran-rdpack 2.6.6-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,156 kB
  • sloc: sh: 13; makefile: 4
file content (50 lines) | stat: -rw-r--r-- 1,726 bytes parent folder | download | duplicates (4)
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
38
39
40
41
42
43
44
45
46
47
48
49
50
\name{parse_text}
\alias{parse_text}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{Parse expressions residing in character vectors}
\description{Parse expressions residing in character vectors.}
\usage{
parse_text(text, ..., keep = TRUE)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{text}{the text to parse, normally a character vector but can be
    anything that \code{parse} accepts for this artgument.}
  \item{\dots}{additional arguments to be passed on to \code{parse}.}
  \item{keep}{required setting for option \verb{keep.source}, see
    details.}
}
\details{
  This is like \code{parse(text=text,\dots)} with the additional feature
  that if the setting of option "keep.source" is not as requested by
  argument \code{keep}, it is set to \code{keep} before calling
  \code{parse} and restored afterwards.

  This function is no longer exported by \pkg{Rdpack} since it is here
  for historical reasons and to avoid unnecessary dependence on
  \pkg{gbutils}. Use the equivalent \code{gbutils::parse_text} instead.
  
}
\value{
  an expression representing the parsed text, see \code{link{parse}} for
  details
}
\author{Georgi N. Boshnakov}
\note{
  The usual setting of option "keep.source" in interactive sessions is
  TRUE. However, in `R CMD check' it is FALSE.

  As a consequence, examples from the documentation may run fine when
  copied and pasted in an R session but (rightly) fail `R CMD check',
  when they depend on  option "keep.source" being \code{TRUE}.

}

%% ~Make other sections like Warning with \section{Warning }{....} ~

\seealso{
  \code{\link{parse}},
  \code{parse_text} in package gbutils
}
\keyword{programming}
\keyword{internal}