setup_test: Set up a test directory to experiment with 'ezspin' or...

In daattali/ezknitr: Avoid the Typical Working Directory Pain When Using 'knitr'

Set up a test directory to experiment with ezspin or ezknit

Description

Create a few directories that try to mimic a real data-analysis project structure, and add a data file and a simple R script (for ezspin) or Rmarkdown file (for ezknit).

After setting up these files and directories, you can run ezknitr commands and their equivalent knitr commands to compare and see the benefits of using ezknitr.

More specific instructions on how to interact with this test directory will be printed to the console.

Usage

setup_ezspin_test()

setup_ezknit_test()

Value

The path to the test directory.

See Also

ezspin spin ezknit knit open_output_dir

Examples

## Not run: 
library(ezknitr)

# setup the test directory structures and run naive spin
setup_ezspin_test()
knitr::spin("ezknitr_test/R/ezspin_test.R")
file.remove(c("ezspin_test.md", "ezspin_test.html"))

# setup the test directory structures and run simple ezspin
setup_ezspin_test()
ezspin("R/ezspin_test.R", wd = "ezknitr_test")

# setup the test directory structures and run ezspin with more parameters
tmp <- setup_ezspin_test()
ezspin("R/ezspin_test.R", wd = "ezknitr_test",
        out_dir = "output", fig_dir = "coolplots")
unlink(tmp, recursive = TRUE, force = TRUE)

## End(Not run)

daattali/ezknitr documentation built on Aug. 20, 2023, 3:29 a.m.