These functions allow you to create an episode that will be added to the schedule.
Usage
create_episode(
title,
ext = "Rmd",
make_prefix = FALSE,
add = TRUE,
path = ".",
open = rlang::is_interactive()
)
create_episode_md(
title,
make_prefix = FALSE,
add = TRUE,
path = ".",
open = rlang::is_interactive()
)
create_episode_rmd(
title,
make_prefix = FALSE,
add = TRUE,
path = ".",
open = rlang::is_interactive()
)
draft_episode_md(
title,
make_prefix = FALSE,
path = ".",
open = rlang::is_interactive()
)
draft_episode_rmd(
title,
make_prefix = FALSE,
path = ".",
open = rlang::is_interactive()
)
Arguments
- title
the title of the episode
- ext
a character. If
ext = "Rmd"
(default), then the new episode will be an R Markdown episode. Ifext = "md"
, then the new episode will be a markdown episode, which can not generate dynamic content.- make_prefix
a logical. When
TRUE
, the prefix for the file will be automatically determined by the files already present. WhenFALSE
(default), it assumes no prefix is needed.- add
(logical or numeric) If numeric, it represents the position the episode should be added. If
TRUE
, the episode is added to the end of the schedule. IfFALSE
, the episode is added as a draft episode.- path
the path to the
{sandpaper}
lesson.- open
if interactive, the episode will open in a new editor window.
Examples
tmp <- tempfile()
create_lesson(tmp, open = FALSE, rmd = FALSE)
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ℹ No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it.
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ℹ To save this configuration, use
#>
#> set_episodes(path = path, order = ep, write = TRUE)
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ☐ Edit /tmp/RtmpQSXDNq/file17061f452ae/episodes/introduction.md.
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ✔ First episode created in /tmp/RtmpQSXDNq/file17061f452ae/episodes/introduction.md
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ℹ Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17061f452ae
#> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae...
#> /tmp/RtmpQSXDNq/file17061f452ae
create_episode_md("getting-started", path = tmp)
#> ☐ Edit /tmp/RtmpQSXDNq/file17061f452ae/episodes/getting-started.md.
#> /tmp/RtmpQSXDNq/file17061f452ae/episodes/getting-started.md