Skip to contents

Get the configuration parameters for the lesson

Usage

get_config(path = ".")

Arguments

path

path to the lesson

Value

a yaml list

Examples

tmp <- tempfile()
create_lesson(tmp, open = FALSE, rmd = FALSE)
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...
#>  No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...

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

#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...

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

#>  Edit '/tmp/RtmpZYggRm/file17f92f9c73d3/episodes/introduction.md'
#>  First episode created in /tmp/RtmpZYggRm/file17f92f9c73d3/episodes/introduction.md
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...

#>  Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...

#>  Lesson successfully created in /tmp/RtmpZYggRm/file17f92f9c73d3
#> → Creating Lesson in /tmp/RtmpZYggRm/file17f92f9c73d3...

#> /tmp/RtmpZYggRm/file17f92f9c73d3
get_config(tmp)
#> $carpentry
#> [1] "incubator"
#> 
#> $title
#> [1] "Lesson Title"
#> 
#> $created
#> [1] "2024-05-08"
#> 
#> $keywords
#> [1] "software, data, lesson, The Carpentries"
#> 
#> $life_cycle
#> [1] "pre-alpha"
#> 
#> $license
#> [1] "CC-BY 4.0"
#> 
#> $source
#> [1] "https://github.com/carpentries/file17f92f9c73d3"
#> 
#> $branch
#> [1] "main"
#> 
#> $contact
#> [1] "team@carpentries.org"
#> 
#> $episodes
#> [1] "introduction.md"
#> 
#> $learners
#> NULL
#> 
#> $instructors
#> NULL
#> 
#> $profiles
#> NULL
#>