check_structure: Check for expected file structure and create missing

Description Usage Arguments Value Examples

Description

Check for expected file structure and create missing

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
make_course(
  course_dir = ".",
  book_txt = NULL,
  verbose = TRUE,
  warn_book_exists = TRUE,
  create_directories = TRUE
)

check_structure(
  course_dir = ".",
  book_txt = NULL,
  verbose = TRUE,
  warn_book_exists = TRUE,
  create_directories = TRUE
)

Arguments

course_dir

directory with course materials

book_txt

A text file with names of markdown files and course names

verbose

print diagnostic messages

warn_book_exists

Should a warning be sent if Book.txt already exists.

create_directories

if the directories do not exist, create them.

Value

A list of the paths necessary for the course

Examples

1
2
3
course_dir = tempfile()
dir.create(course_dir)
make_course(course_dir)

muschellij2/didactr documentation built on March 17, 2021, 12:45 p.m.