File: eval.msgs.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 (69 lines) | stat: -rw-r--r-- 3,132 bytes parent folder | download
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/evals.R
\name{eval.msgs}
\alias{eval.msgs}
\title{Evaluate with messages}
\usage{
eval.msgs(src, env = NULL, showInvisible = FALSE,
  graph.unify = evalsOptions("graph.unify"))
}
\arguments{
\item{src}{character values containing R code}

\item{env}{environment where evaluation takes place. If not set (by default), a new temporary environment is created.}

\item{showInvisible}{return \code{invisible} results?}

\item{graph.unify}{should \code{eval.msgs} try to unify the style of (\code{lattice} and \code{ggplot2}) plots? If set to \code{TRUE} (by default), some \code{panderOptions()} would apply. Please note that this argument has no effect on \code{base} plots, use \code{evals} instead.}
}
\value{
a list of parsed elements each containing: \code{src} (the command run), \code{result} (R object: \code{NULL} if nothing returned), \code{print}ed \code{output}, \code{type} (class of returned object if any), informative/wawrning and error messages (if any returned by the command run, otherwise set to \code{NULL}) and possible \code{stdout}t value. See Details above.
}
\description{
This function takes text(s) of R code and \code{eval}s all at one run - returning a list with four elements. See \code{Details}.
}
\details{
\code{eval.msgs} returns a detailed list of the result of evaluation:
\itemize{
    \item \emph{src} - character vector of specified R code.
    \item \emph{result} - result of evaluation. \code{NULL} if nothing is returned. If any R code returned an R object while evaluating then the \emph{last} R object will be returned as a raw R object. If a graph is plotted in the end of the given R code (remember: \emph{last} R object), it would be automatically printed (see e.g. \code{lattice} and \code{ggplot2}).
     \item \emph{output} - character vector of printed version (\code{capture.output}) of \code{result}
    \item \emph{type} - class of generated output. 'NULL' if nothing is returned, 'error' if some error occurred.
    \item \emph{msg} - possible messages grabbed while evaluating specified R code with the following structure:
    \itemize{
        \item \emph{messages} - character vector of possible diagnostic message(s)
        \item \emph{warnings} - character vector of possible warning message(s)
        \item \emph{errors} - character vector of possible error message(s)
    }
    \item \emph{stdout} - character vector of possibly printed texts to standard output (console)
}
}
\examples{
\dontrun{
eval.msgs('1:5')
eval.msgs('x <- 1:5')
eval.msgs('lm(mtcars$hp ~ mtcars$wt)')

## plots
eval.msgs('plot(runif(100))')
eval.msgs('histogram(runif(100))')

## error handling
eval.msgs('runiff(23)')
eval.msgs('runif is a nice function')
eval.msgs('no.R.object.like.that')

## messages
eval.msgs(c('message("FOO")', '1:2'))
eval.msgs(c('warning("FOO")', '1:2'))
eval.msgs(c('message("FOO");message("FOO");warning("FOO")', '1:2'))
eval.msgs('warning("d");warning("f");1')

## stdout
eval.msgs('cat("writing to console")')
eval.msgs('cat("writing to console");1:4')
}
}
\seealso{
\code{\link{evals}}
}