Statamarkdown (version 0.9.6)

stata_engine: Define a Stata engine for knitr

Description

This function creates a modified Stata engine.

Set up once per session (i.e. document). Ordinarily this is run automatically when Statamarkdown is loaded.

Usage

stata_engine(options)

Value

The language engine function returns Stata code and output internally to knitr.

Arguments

options

options are passed to the engine function when it is actually invoked within knitr.

Author

Doug Hemken

Details

This function is used as follows.

• stata_engine(options) is a language engine that returns Stata log output.

  The end user should not need to use the language engine function directly. This is the workhorse function that actually calls Stata and returns output.

See Also

knitr:knit_engines

Examples

indoc <- '
# An R console example
## In a first code chunk, set up with
```{r}
library(Statamarkdown)
```

## Then mark Stata code chunks with
```{stata}
sysuse auto, clear
generate gpm = 1/mpg
summarize price gpm
```
'

if (!is.null(Statamarkdown::find_stata())) {
  # To run this example, remove tempdir().
  fmd <- file.path(tempdir(), "test.md")
  fhtml <- file.path(tempdir(), "test.html")

  knitr::knit(text=indoc, output=fmd)
  rmarkdown::render(fmd, "html_document", fhtml)
}