forked from jhudsl/ariExtra
/
README.Rmd
56 lines (45 loc) · 2.03 KB
/
README.Rmd
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
---
output: github_document
---
<!-- badges: start -->
[](https://travis-ci.com/jhudsl/ariExtra)
[](https://ci.appveyor.com/project/jhudsl/ariExtra)
[](https://github.com/muschellij2/ariExtra/actions)
<!-- badges: end -->
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# ariExtra Package:
The goal of `ariExtra` is to provide leverages the `ari`' package and other tools to create automated courses from slides and a script.
## Installation
You can install `ariExtra` from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("jhudsl/ariExtra")
```
## Example
```{r, eval = FALSE}
library(ariExtra)
id = "1Opt6lv7rRi7Kzb9bI0u3SWX1pSz1k7botaphTuFYgNs"
res = gs_to_ari(id, verbose = FALSE, voice = "Joanna", service = "amazon", open = FALSE)
```
```{r, include=FALSE}
x = c("---", "output:", " ariExtra::ari_document:", " voice: Joanna",
" service: amazon", " verbose: no", "---", "", "", "----------",
"", "<!--Lean pub created a mook platform. We want to discuss some options for creating courses with Lean pub at Johns Hopkins.-->",
"",
"", "", "----------", "", "<!--Here is an example of the way Lean pub turns text into an output course. The left hand side is written in a markdown format called Markua.-->",
"",
"")
output_file = tempfile(fileext = ".md")
writeLines(x, output_file)
res = list(output_file = output_file)
```
```{r}
head(readLines(res$output_file), 20)
```