Skip to contents

This fuction will extract the resources that exist and are listed in the config file.

Usage

get_dropdown(path = ".", folder, trim = TRUE)

get_episodes(path = ".", trim = TRUE)

get_learners(path = ".", trim = TRUE)

get_instructors(path = ".", trim = TRUE)

get_profiles(path = ".", trim = TRUE)

Arguments

path

the path to the lesson, defaults to the current working directory

folder

the folder to extract fromt he dropdown menues

trim

if TRUE (default), only the file name will be presented. When FALSE, the full path will be prepended.

Value

a character vector of episodes in order of presentation

Examples

tmp <- tempfile()
create_lesson(tmp)
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...
#>  No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

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

#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

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

#>  First episode created in /tmp/RtmpsPBux1/file1a8875f44ec3/episodes/introduction.Rmd
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

#>  Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

#>  Consent to use package cache provided
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

#> → Searching for and installing available dependencies
#> * Discovering package dependencies ... Done!
#> * Copying packages into the library ... Done!
#> → 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.4.2]
#> - cachem      [* -> 1.0.6]
#> - cli         [* -> 3.6.0]
#> - digest      [* -> 0.6.31]
#> - ellipsis    [* -> 0.3.2]
#> - evaluate    [* -> 0.20]
#> - fastmap     [* -> 1.1.0]
#> - fs          [* -> 1.6.0]
#> - glue        [* -> 1.6.2]
#> - highr       [* -> 0.10]
#> - htmltools   [* -> 0.5.4]
#> - jquerylib   [* -> 0.1.4]
#> - jsonlite    [* -> 1.8.4]
#> - knitr       [* -> 1.42]
#> - lifecycle   [* -> 1.0.3]
#> - magrittr    [* -> 2.0.3]
#> - memoise     [* -> 2.0.1]
#> - mime        [* -> 0.12]
#> - rappdirs    [* -> 0.3.3]
#> - renv        [* -> 0.16.0]
#> - rlang       [* -> 1.0.6]
#> - rmarkdown   [* -> 2.20]
#> - sass        [* -> 0.4.5]
#> - stringi     [* -> 1.7.12]
#> - stringr     [* -> 1.5.0]
#> - tinytex     [* -> 0.43]
#> - vctrs       [* -> 0.5.2]
#> - xfun        [* -> 0.36]
#> - yaml        [* -> 2.3.7]
#> 
#> The version of R recorded in the lockfile will be updated:
#> - R           [*] -> [4.2.2]
#> 
#> * Lockfile written to '/tmp/RtmpsPBux1/file1a8875f44ec3/renv/profiles/lesson-requirements/renv.lock'.
#>  Lesson successfully created in /tmp/RtmpsPBux1/file1a8875f44ec3
#> → Creating Lesson in /tmp/RtmpsPBux1/file1a8875f44ec3...

#> /tmp/RtmpsPBux1/file1a8875f44ec3
get_episodes(tmp)
#> [1] "introduction.Rmd"
get_learners(tmp) # information for learners
#> [1] "setup.md"