Package 'joholearnr'

List all tutorials

Description

Lists all tutorials (Rmd files) in joholearnr

Usage

list_tutorials()

Value

Character vector

Examples

list_tutorials()

---

Snapshot all tutorial files

Description

Create an renv.lock file for each tutorial

Usage

snapshot_tutorials(dir = "./tutorials")

Arguments

dir	Directory containing the tutorials. Each should be in its own subdirectory; see system.file("tutorials", package = "joholearnr")

Value

Nothing. Externally, the renv files will be written to disk.

Examples

if (interactive()) {
  tutorials_folder <- system.file("tutorials", package = "joholearnr")
  temp_tutorials_folder <- fs::path(tempdir(), "tutorials")
  fs::dir_copy(tutorials_folder, temp_tutorials_folder, overwrite = TRUE)
  snapshot_tutorials(temp_tutorials_folder)
  fs::dir_delete(temp_tutorials_folder)
}

---

Object with a long name

Description

This is provided only for practicing using the tab key to autocomplete a long name

Usage

this_is_a_really_long_name

Format

An object of class numeric of length 1.

---

Write out all tutorial files

Description

Write out all tutorial files (Rmd) file to disk

Usage

write_all_tutorials(dir = ".", delete_html = TRUE)

Arguments

dir	Directory to write the files.
delete_html	Logical; should HTML files in the tutorials directory be deleted after copying?

Value

Nothing. Externally, the file will be written to disk. (Subfolders may be used)

Examples

target_dir <- fs::path(tempdir(), "tutorials")
write_all_tutorials(target_dir)
fs::dir_ls(target_dir)
fs::dir_delete(target_dir)

---

Write out a tutorial file

Description

Write out a tutorial (Rmd) file to disk

Usage

write_tutorial(tutorial, dir = ".")

Arguments

tutorial	Name of the tutorial file. The .Rmd extension may be omitted.
dir	Directory to write the file.

Value

Nothing. Externally, the file will be written to disk.

Examples

write_tutorial("00-learnr", tempdir())
list.files(tempdir())

---