pkgslides/README.Rmd at main · guslipkin/pkgslides · GitHub

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
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# pkgslides

<!-- badges: start -->
<!-- badges: end -->

The goal of `pkgslides` is to make it easier for you to learn about R packages by converting existing documentation into an easily digested slideshow.

## Installation

You can install the development version of pkgslides from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("guslipkin/pkgslides")
```

## Example

This is a basic example which will build and render a [Quarto RevealJS](https://quarto.org/docs/presentations/revealjs/) presentation for `pkgslides`:

```{r include=FALSE}
file.remove("_pkgslides.yml")
file.copy("pkgslides.html", "docs")
```

```{r example}
pkgslides::build_presentation()
```