This will create a boilerplate directory structure for a Carpentries lesson and initialize a git repository.
Usage
create_lesson(
path,
name = fs::path_file(path),
rmd = TRUE,
rstudio = rstudioapi::isAvailable(),
open = rlang::is_interactive()
)Arguments
- path
the path to the new lesson folder
- name
the name of the lesson. If not provided, the folder name will be used.
- rmd
logical indicator if the lesson should use R Markdown (
TRUE, default), or if it should use Markdown (FALSE). Note that lessons can be converted to use R Markdown at any time by adding a file with the.Rmdfile extension in the lesson.- rstudio
create an RStudio project (defaults to if RStudio exits)
- open
if interactive, the lesson will open in a new editor window.
Examples
tmp <- tempfile()
on.exit(unlink(tmp))
lsn <- create_lesson(tmp, name = "This Lesson", open = FALSE)
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ℹ No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ℹ To save this configuration, use
#>
#> set_episodes(path = path, order = ep, write = TRUE)
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ☐ Edit /tmp/RtmplOXhie/file1bc52c37308c/episodes/introduction.Rmd.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ✔ First episode created in /tmp/RtmplOXhie/file1bc52c37308c/episodes/introduction.Rmd
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ℹ Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> ℹ Consent to use package cache provided
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
#> - 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.6.1
#> - base64enc 0.1-3
#> - bslib 0.9.0
#> - cachem 1.1.0
#> - cli 3.6.5
#> - digest 0.6.37
#> - evaluate 1.0.3
#> - fastmap 1.2.0
#> - fontawesome 0.5.3
#> - fs 1.6.6
#> - glue 1.8.0
#> - highr 0.11
#> - htmltools 0.5.8.1
#> - jquerylib 0.1.4
#> - jsonlite 2.0.0
#> - knitr 1.50
#> - lifecycle 1.0.4
#> - memoise 2.0.1
#> - mime 0.13
#> - rappdirs 0.3.3
#> - rlang 1.1.6
#> - rmarkdown 2.29
#> - sass 0.4.10
#> - tinytex 0.57
#> - xfun 0.52
#> - yaml 2.3.10
#>
#> They will be copied into the project library.
#>
#> - Copying packages into the project library ... Done!
#> - Hydrated 26 packages in 0.19 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:
#>
#> # https://packagemanager.posit.co/cran/__linux__/noble/latest ----------------
#> - R6 [* -> 2.6.1]
#> - base64enc [* -> 0.1-3]
#> - bslib [* -> 0.9.0]
#> - cachem [* -> 1.1.0]
#> - cli [* -> 3.6.5]
#> - digest [* -> 0.6.37]
#> - evaluate [* -> 1.0.3]
#> - fastmap [* -> 1.2.0]
#> - fontawesome [* -> 0.5.3]
#> - fs [* -> 1.6.6]
#> - glue [* -> 1.8.0]
#> - highr [* -> 0.11]
#> - htmltools [* -> 0.5.8.1]
#> - jquerylib [* -> 0.1.4]
#> - jsonlite [* -> 2.0.0]
#> - knitr [* -> 1.50]
#> - lifecycle [* -> 1.0.4]
#> - memoise [* -> 2.0.1]
#> - mime [* -> 0.13]
#> - rappdirs [* -> 0.3.3]
#> - renv [* -> 1.1.4]
#> - rlang [* -> 1.1.6]
#> - rmarkdown [* -> 2.29]
#> - sass [* -> 0.4.10]
#> - tinytex [* -> 0.57]
#> - xfun [* -> 0.52]
#> - yaml [* -> 2.3.10]
#>
#> The version of R recorded in the lockfile will be updated:
#> - R [* -> 4.5.0]
#>
#> - Lockfile written to "/tmp/RtmplOXhie/file1bc52c37308c/renv/profiles/lesson-requirements/renv.lock".
#> ✔ Lesson successfully created in /tmp/RtmplOXhie/file1bc52c37308c
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc52c37308c...
lsn
#> /tmp/RtmplOXhie/file1bc52c37308c