ariExtra (version 0.3.1)

make_ari_document: Make an ari document

Description

Make an ari document

Usage

make_ari_document(
  images,
  script,
  output_file = NULL,
  open = interactive(),
  use_knitr = FALSE,
  ...,
  verbose = TRUE
)
pngs_to_ari(
  images,
  script,
  output_file = NULL,
  open = interactive(),
  use_knitr = FALSE,
  ...,
  verbose = TRUE
)

Arguments

images

a vector of paths to images.

script

a file or vector strings that will be spoken

output_file

a path to the Rmd file which will be created.

open

should the Rmd be opened after creating?

use_knitr

use an Rmarkdown type syntax for including the images

...

additional arguments to pass to ari::ari_spin

verbose

print diagnostic messages and also passed to ari::ari_stitch

Value

A path to the document

Examples

# NOT RUN {
images = system.file("extdata", c("example_1.png", "example_2.png"),
package = "ariExtra")
res = make_ari_document(images, script = c("hello", "how are you"))
res$output_file
res = make_ari_document(images, script = c("hello", "how are you"),
use_knitr = TRUE)
res$output_file

res = to_ari(images, script = c("hello", "how are you"), open = FALSE)
# }