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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
#' Build tutorials section
#'
#' learnr tutorials must be hosted elsewhere as they require an
#' R execution engine. Currently, pkgdown will not build or publish tutorials
#' for you, but makes it easy to embed (using `<iframe>`s) published tutorials.
#' Tutorials are automatically discovered from published tutorials in
#' `inst/tutorials` and `vignettes/tutorials`. Alternatively, you can
#' list in `_pkgdown.yml` as described below.
#'
#' # YAML config
#' To override the default discovery process, you can provide a `tutorials`
#' section. This should be a list where each element specifies:
#'
#' * `name`: used for the generated file name
#' * `title`: used in page heading and in navbar
#' * `url`: which will be embedded in an iframe
#' * `source`: optional, but if present will be linked to
#'
#' ```yaml
#' tutorials:
#' - name: 00-setup
#' title: Setting up R
#' url: https://jjallaire.shinyapps.io/learnr-tutorial-00-setup/
#' - name: 01-data-basics
#' title: Data basics
#' url: https://jjallaire.shinyapps.io/learnr-tutorial-01-data-basics/
#' ```
#' @inheritParams build_articles
#' @family site components
#' @export
build_tutorials <- function(pkg = ".", override = list(), preview = FALSE) {
pkg <- section_init(pkg, "tutorials", override = override)
tutorials <- pkg$tutorials
if (nrow(tutorials) == 0) {
return(invisible())
}
cli::cli_rule("Building tutorials")
data <- purrr::transpose(tutorials)
# Build index
render_page(pkg, "tutorial-index",
data = list(
pagetitle = tr_("Tutorials"),
tutorials = purrr::transpose(list(
path = path_rel(tutorials$file_out, "tutorials"),
title = tutorials$title
))
),
path = "tutorials/index.html"
)
purrr::pwalk(
list(data = data, path = tutorials$file_out),
render_page,
pkg = pkg,
name = "tutorial"
)
preview_site(pkg, "tutorials", preview = preview)
}
package_tutorials <- function(path = ".", meta = list()) {
# Look first in meta data
tutorials <- purrr::pluck(meta, "tutorials")
# Then scan tutorials directories
if (length(tutorials) == 0) {
tutorials <- c(
find_tutorials(path(path, "inst", "tutorials")),
find_tutorials(path(path, "vignettes", "tutorials"))
)
}
name <- purrr::map_chr(tutorials, "name")
title <- purrr::map_chr(tutorials, "title")
tibble::tibble(
name = name,
file_out = as.character(path("tutorials", name, ext = "html")),
title = title,
pagetitle = title,
url = purrr::map_chr(tutorials, "url")
)
}
find_tutorials <- function(path = ".") {
if (!dir_exists(path)) {
return(character())
}
check_installed("rsconnect", "to find published tutorials")
rmds <- unname(dir_ls(path, recurse = TRUE, regexp = "\\.[Rrq]md$", type = "file"))
info <- purrr::map(rmds, tutorial_info, base_path = path)
purrr::compact(info)
}
tutorial_info <- function(path, base_path) {
yaml <- rmarkdown::yaml_front_matter(path)
title <- yaml$title
if (is.null(title)) {
return()
}
# Must have "runtime: shiny". Partial implementation of full algorithm:
# https://github.com/rstudio/rmarkdown/blob/master/R/shiny.R#L72-L100
runtime <- yaml$runtime
if (is.null(runtime) || !grepl("^shiny", runtime)) {
return()
}
# Find deployment url. Use excludeOrphaned = FALSE since we don't need
# to worry about redeploying and this makes test infrastructure a little
# simpler
deploys <- rsconnect::deployments(path, excludeOrphaned = FALSE)
if (!is.null(deploys) && nrow(deploys) >= 1) {
latest <- which.max(deploys$when)
url <- deploys$url[[latest]]
} else {
return()
}
list(
name = as.character(path_ext_remove(path_file(path))),
title = yaml$title,
url = url
# source = as.character(path_rel(path, base_path))
)
}
|
