check_course: Check Leanpub Course

Description Usage Arguments Value Examples

View source: R/check_course.R

Description

Check Leanpub Course

Usage

1
2
3
4
5
6
7
8
9
check_course(
  course_dir = ".",
  save_metrics = TRUE,
  timezone = "America/New_York",
  require_authorization = TRUE,
  use_book = FALSE,
  check_youtube_links = TRUE,
  ...
)

Arguments

course_dir

directory with course materials

save_metrics

Should an 'rds' file be saved of the 'data.frame'?

timezone

Timezone to be used?

require_authorization

Should you authorize for Google Slides and such to check the modified time?

use_book

Use Book.txt to keep only the manuscript files that were specified.

check_youtube_links

Should YouTube links be checked? If starting a course, set to FALSE

...

arguments to pass to didactr_auth

Value

A list of data frames of the checked course. Will have class course_check

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
root_path = tempfile()
course_name = "test this out2"
book_txt =  system.file("extdata", "Book.txt", package = "didactr")
sc = create_course(course_name, root_path, book_txt = book_txt)
course_dir = sc$course_dir
in_ci <- function() {
nzchar(Sys.getenv("CI"))
}
if (!in_ci()) {
object = check_course(sc$course_dir, require_authorization = FALSE)
}

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