Skip to contents

If you need to move a single episode, this function gives you a programmatic or interactive interface to accomplishing this task, whether you need to add and episode, draft, or remove an episode from the schedule.

Usage

move_episode(ep = NULL, position = NULL, write = FALSE, path = ".")

Arguments

ep

the name of a draft episode or the name/number of a published episode to move.

position

the position in the schedule to move the episode. Valid positions are from 0 to the number of episodes (+1 for drafts). A value of 0 indicates that the episode should be removed from the schedule.

write

defaults to FALSE, which will show the potential changes. If TRUE, the schedule will be modified and written to config.yaml

path

the path to the lesson (defaults to the current working directory)

Examples

if (interactive() || Sys.getenv("CI") != "") {
  tmp <- tempfile()
  create_lesson(tmp)
  create_episode_md("getting-started", path = tmp)
  create_episode_rmd("plotting", path = tmp)
  create_episode_md("experimental", path = tmp, add = FALSE)
  set_episodes(tmp, c("getting-started.md", "introduction.Rmd", "plotting.Rmd"), 
    write = TRUE)

  # Default episode order is alphabetical, we can use this to nudge episodes
  get_episodes(tmp)
  move_episode("introduction.Rmd", 1L, path = tmp) # by default, it shows you the change
  move_episode("introduction.Rmd", 1L, write = TRUE, path = tmp) # write the results
  get_episodes(tmp)

  # Add episodes from the drafts
  get_drafts(tmp)
  move_episode("experimental.md", 2L, path = tmp) # view where it will live
  move_episode("experimental.md", 2L, write = TRUE, path = tmp) 
  get_episodes(tmp)

  # Unpublish episodes by setting position to zero
  move_episode("experimental.md", 0L, path = tmp) # view the results
  move_episode("experimental.md", 0L, write = TRUE, path = tmp)
  get_episodes(tmp)

  # Interactively select the position where the episode should go by omitting
  # the position argument
  if (interactive()) {
    move_episode("experimental.md", path = tmp)
  }
}
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...
#>  No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#> To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it.
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#>  To save this configuration, use
#> 
#> set_episodes(path = path, order = ep, write = TRUE)
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#>  First episode created in /tmp/RtmpUWqX2P/file1880463495ad/episodes/introduction.Rmd
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#>  Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#>  Consent to use package cache provided
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#> - The project is out-of-sync -- use `renv::status()` for details.
#> → Searching for and installing available dependencies
#> The following packages were discovered:
#> 
#> # ~/work/_temp/Library -------------------------------------------------------
#> - R6            2.5.1
#> - base64enc     0.1-3
#> - bslib         0.5.1
#> - cachem        1.0.8
#> - cli           3.6.1
#> - digest        0.6.33
#> - ellipsis      0.3.2
#> - evaluate      0.21
#> - fastmap       1.1.1
#> - fontawesome   0.5.2
#> - fs            1.6.3
#> - glue          1.6.2
#> - highr         0.10
#> - htmltools     0.5.6
#> - jquerylib     0.1.4
#> - jsonlite      1.8.7
#> - knitr         1.44
#> - lifecycle     1.0.3
#> - magrittr      2.0.3
#> - memoise       2.0.1
#> - mime          0.12
#> - rappdirs      0.3.3
#> - rlang         1.1.1
#> - rmarkdown     2.25
#> - sass          0.4.7
#> - stringi       1.7.12
#> - stringr       1.5.0
#> - tinytex       0.46
#> - vctrs         0.6.3
#> - xfun          0.40
#> - yaml          2.3.7
#> 
#> They will be copied into the project library.
#> 
#> - Copying packages into the project library ... Done!
#> - Hydrated 31 packages in 0.31 seconds.
#> - The project is out-of-sync -- use `renv::status()` for details.
#> → Recording changes in lockfile
#> The following package(s) will be updated in the lockfile:
#> 
#> # RSPM -----------------------------------------------------------------------
#> - R6            [* -> 2.5.1]
#> - base64enc     [* -> 0.1-3]
#> - bslib         [* -> 0.5.1]
#> - cachem        [* -> 1.0.8]
#> - cli           [* -> 3.6.1]
#> - digest        [* -> 0.6.33]
#> - ellipsis      [* -> 0.3.2]
#> - evaluate      [* -> 0.21]
#> - fastmap       [* -> 1.1.1]
#> - fontawesome   [* -> 0.5.2]
#> - fs            [* -> 1.6.3]
#> - glue          [* -> 1.6.2]
#> - highr         [* -> 0.10]
#> - htmltools     [* -> 0.5.6]
#> - jquerylib     [* -> 0.1.4]
#> - jsonlite      [* -> 1.8.7]
#> - knitr         [* -> 1.44]
#> - lifecycle     [* -> 1.0.3]
#> - magrittr      [* -> 2.0.3]
#> - memoise       [* -> 2.0.1]
#> - mime          [* -> 0.12]
#> - rappdirs      [* -> 0.3.3]
#> - renv          [* -> 1.0.3]
#> - rlang         [* -> 1.1.1]
#> - rmarkdown     [* -> 2.25]
#> - sass          [* -> 0.4.7]
#> - stringi       [* -> 1.7.12]
#> - stringr       [* -> 1.5.0]
#> - tinytex       [* -> 0.46]
#> - vctrs         [* -> 0.6.3]
#> - xfun          [* -> 0.40]
#> - yaml          [* -> 2.3.7]
#> 
#> The version of R recorded in the lockfile will be updated:
#> - R             [* -> 4.3.1]
#> 
#> - Lockfile written to "/tmp/RtmpUWqX2P/file1880463495ad/renv/profiles/lesson-requirements/renv.lock".
#>  Lesson successfully created in /tmp/RtmpUWqX2P/file1880463495ad
#> → Creating Lesson in /tmp/RtmpUWqX2P/file1880463495ad...

#> episodes:
#> - introduction.Rmd
#> - getting-started.md
#> - plotting.Rmd
#> 
#> ────────────────────────────────────────────────────────────────────────
#>  To save this configuration, use
#> 
#> move_episode(ep = "introduction.Rmd", position = 1, path = tmp, write = TRUE)
#>  Files are in draft: episodes/experimental.md
#>  All files in learners/ published (config.yaml empty)
#>  All files in instructors/ published (config.yaml empty)
#>  All files in profiles/ published (config.yaml empty)
#> episodes:
#> - introduction.Rmd
#> - experimental.md
#> - getting-started.md
#> - plotting.Rmd
#> 
#> ────────────────────────────────────────────────────────────────────────
#>  To save this configuration, use
#> 
#> move_episode(ep = "experimental.md", position = 2, path = tmp, write = TRUE)
#> episodes:
#> - introduction.Rmd
#> - getting-started.md
#> - plotting.Rmd
#> 
#> ── Removed episodes ────────────────────────────────────────────────────
#> - experimental.md
#> ────────────────────────────────────────────────────────────────────────
#>  To save this configuration, use
#> 
#> move_episode(ep = "experimental.md", position = 0, path = tmp, write = TRUE)