create_course: Starting a Course, Light wrapper for 'make_course'

Description Usage Arguments Value Examples

View source: R/start_course.R

Description

Starting a Course, Light wrapper for make_course

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
create_course(
  course_name,
  root_path = ".",
  book_txt = NULL,
  folder_id = NULL,
  verbose = TRUE,
  rstudio = TRUE,
  open = FALSE,
  git = FALSE,
  ...
)

Arguments

course_name

Name of the course. Any spaces will be set to underscores

root_path

The directory to put the course into.

book_txt

A text file with names of markdown files and course names

folder_id

Google ID for a folder of presentations

verbose

print diagnostic messages

rstudio

If TRUE, calls use_rstudio() to make the new package or project into an RStudio Project.

open

If TRUE, activates the new project: If RStudio desktop, the package is opened in a new session. Otherwise, the working directory and active project is changed.

git

If TRUE, calls use_git() to use Git inside the project.

...

additional argument to pass to create_lesson

Value

The output of make_course.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
root_path = tempfile()
course_name = "test this out"
sc = create_course(course_name, root_path)


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)
readLines(sc$book_txt)
md_files = list.files(sc$man_path, full.names = TRUE)
md_files
readLines(md_files[1])

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