File: run_and_capture.Rd

package info (click to toggle)
r-cran-simplermarkdown 0.0.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 392 kB
  • sloc: makefile: 2
file content (45 lines) | stat: -rw-r--r-- 1,354 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/run_and_capture.R
\name{run_and_capture}
\alias{run_and_capture}
\title{Run code and capture the output}
\usage{
run_and_capture(
  code,
  echo = TRUE,
  results = TRUE,
  output = results,
  capture_warnings = FALSE,
  capture_messages = results,
  muffle_warnings = FALSE,
  muffle_messages = TRUE
)
}
\arguments{
\item{code}{character vector or expression with the code to run}

\item{echo}{the code in \code{code} is repeated in the output.}

\item{results}{include the results of running the code in the output.}

\item{output}{include output that is explicitly written to the output, for
example using \code{print} statements.}

\item{capture_warnings}{include warnings in the output.}

\item{capture_messages}{include messages in the output.}

\item{muffle_warnings}{do not show warnings in the console.}

\item{muffle_messages}{do not show messages in the console.}
}
\value{
Returns a list. Each item of the list contains a list with elements
\code{input} and \code{output}. \code{input} contains the command/code and
\code{output} the corresponding output. These are empty vectors when there is
no output or when input and output are suppressed using one of the
\code{echo}/\code{results}/\code{output} statements.
}
\description{
Run code and capture the output
}