Skip to contents

Helpers to extract contents of dropdown menus on the site

Source: R/get_dropdown.R
get_dropdown.Rd

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, open = FALSE, rmd = FALSE)
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...
#> ℹ No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

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

#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

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

#> ☐ Edit /tmp/RtmpitXu2m/file19b3130691c/episodes/introduction.md.
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> ✔ First episode created in /tmp/RtmpitXu2m/file19b3130691c/episodes/introduction.md
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> ℹ Using GitHub token for authenticated API request.
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> ℹ Downloading workflows from https://api.github.com/repos/carpentries/workbench-workflows/releases/latest
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> ℹ Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> ✔ Lesson successfully created in /tmp/RtmpitXu2m/file19b3130691c
#> → Creating Lesson in /tmp/RtmpitXu2m/file19b3130691c...

#> /tmp/RtmpitXu2m/file19b3130691c
get_episodes(tmp)
#> [1] "introduction.md"
get_learners(tmp) # information for learners
#> [1] "reference.md" "setup.md"